com.adobe.idp.dsc.registry.endpoint
Class CreateEndpointInfo

java.lang.Object
  com.adobe.idp.dsc.registry.endpoint.CreateEndpointInfo

All Implemented Interfaces:

java.io.Serializable

public class CreateEndpointInfo
extends java.lang.Object
implements java.io.Serializable

Enables the creation of an endpoint that is able to invoke a service. When programmatically adding an endpoint, you create a CreateEndpointInfo object that defines endpoint attributes such as the service that is invoked and the name of the endpoint. For information about programmatically adding an endpoint, see Managing Endpoints in the LiveCycle SDK Help.

See Also:

Serialized Form

Nested Class Summary

class	CreateEndpointInfo.InputMapping Represents an input data mapping value that is associated with an endpoint.
class	CreateEndpointInfo.OutputMapping Represents an output data mapping value that is associated with an endpoint.

Constructor Summary

CreateEndpointInfo()
A constructor that creates a CreateEndpointInfo object.

Method Summary

java.lang.String	getCategoryId() Retrieves the endpoint category identifier value.
java.util.Map	getConfigParametersAsText() Retrieves configuration values that are applicable to an endpoint.
java.lang.String	getConnectorId() Retrieves the connector identifier value that belongs to this endpoint.
java.lang.String	getDescription() Retrieves a description of the endpoint.
java.util.Map	getInputParameterMappings() Retrieves input data mapping values that are associated with this endpoint.
java.lang.String	getName() Retrieves the name of this endpoint.
java.lang.String	getOperationName() Retrieves the operation name that is invoked by this endpoint.
java.util.Map	getOutputParameterMappings() Retrieves the output data mapping value that is associated with this endpoint.
java.lang.String	getServiceId() Retrieves the service idenitifer value that is invoked using this endpoint.
boolean	isEnabled() Retrives a value that specifies whether the endpoint is enabled.
void	setCategoryId(java.lang.String aId) Sets the endpoint category.
void	setConfigParameterAsText(java.lang.String aParamName, java.lang.String aValue) Sets endpoint configuration values.
void	setConnectorId(java.lang.String aId) Set this endpoint's connector identifier value.
void	setDescription(java.lang.String aDescription) Sets the description of the endpoint.
void	setEnabled(boolean aEnabled) Sets a flag that specifies whether the endpoint is enabled.
void	setInputParameterMapping(java.lang.String aParamName, java.lang.String aDataType, java.lang.String aMappingType, java.lang.String aMappingValue) Sets input data mapping values for this endpoint.
void	setName(java.lang.String aName) Sets the name of this endpoint.
void	setOperationName(java.lang.String aOperationName) Sets the the operation name that is invoked using this endpoint.
void	setOutputParameterMapping(java.lang.String aParamName, java.lang.String aDataType, java.lang.String aMappingValue) Sets the output data mapping value for this endpoint.
void	setServiceId(java.lang.String aId) Sets the service identifier value that belongs to this endpoint.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CreateEndpointInfo

public CreateEndpointInfo()

A constructor that creates a CreateEndpointInfo object.

Method Detail

setName

public void setName(java.lang.String aName)

Sets the name of this endpoint.

To see this method used in a code example, see the Adding a Watched Folder endpoint using the Java API in the LiveCycle SDK Help.

Parameters:

aName - The name of this endpoint.

getName

public java.lang.String getName()

Retrieves the name of this endpoint.

Returns:

A string value that specifies the name of this endpoint.

setConnectorId

public void setConnectorId(java.lang.String aId)

Set this endpoint's connector identifier value. You can pass one of the following values when invoking this method:

• EJB: Enables a client application to invoke a service using the EJB mode.
• SOAP: Enables a client application to invoke a service using the SOAP mode.
• WatchedFolder: Enables a Watched Folder to invoke a service.
• Email: Enables an email message to invoke a service.
• Remoting: Enables a Flex client application to invoke a service.
• TaskManagerConnector: Enables a Workspace user to invoke a service from within Workspace.

To see this method used in a code example, see the Adding a Watched Folder endpoint using the Java API in the LiveCycle SDK Help.

Parameters:

aId - A string value that specifies the connector identifier value.

See Also:

Connector

getConnectorId

public java.lang.String getConnectorId()

Retrieves the connector identifier value that belongs to this endpoint.

Returns:

A string value that specifies the connector identifer value.

setServiceId

public void setServiceId(java.lang.String aId)

Sets the service identifier value that belongs to this endpoint. This value specifies the service that is invoked using this endpoint.

To see this method used in a code example, see the Adding a Watched Folder endpoint using the Java API quick start in the LiveCycle SDK Help.

Parameters:

aId - The name of the service that is invoked using this endpoint.

getServiceId

public java.lang.String getServiceId()

Retrieves the service idenitifer value that is invoked using this endpoint.

Returns:

A string value that represents the name of the service that is invoked using this endpoint.

setCategoryId

public void setCategoryId(java.lang.String aId)

Sets the endpoint category. Categories are used to organize services within Workspace ES.

To see this method used in a code example, see the Adding a TaskManager endpoint using the Java API quick start in the LiveCycle SDK Help.

Parameters:

aId - The name of the category that is associated with this endpoint.

getCategoryId

public java.lang.String getCategoryId()

Retrieves the endpoint category identifier value. Categories are used to organize services within Workspace ES.

Returns:

A string value that specifies the identifier value of the category that is associated with this endpoint.

setInputParameterMapping

public void setInputParameterMapping(java.lang.String aParamName,
                                     java.lang.String aDataType,
                                     java.lang.String aMappingType,
                                     java.lang.String aMappingValue)

Sets input data mapping values for this endpoint. Input data mapping values describe the input values that are passed to the service operation invoked by this endpoint.

To see this method used in a code example, see the Adding a Watched Folder endpoint using the Java API quick start in the LiveCycle SDK Help.

Parameters:

aParamName - The name of the input parameter.

aDataType - The data type of the input parameter.

aMappingType - Used to configure the input values required to invoke the service operation. The following mapping types exist:

• Literal: An endpoint uses the value entered in the field as it is displayed. All basic Java types are supported. For example, if an API uses input such as String, long, int, and Boolean then the string is converted into the proper type and the service is invoked.
• Variable: The value entered is a file pattern that the endpoint uses to pick the input. For example, if you select Variable for the mapping type and the input document is a PDF file, you can specify *.pdf as the mapping value.

aMappingValue - Specifies the value of the mapping type. For example, if you select a Variable mapping type, then you can specify *.pdf as the file pattern.

getInputParameterMappings

public java.util.Map getInputParameterMappings()

Retrieves input data mapping values that are associated with this endpoint.

Returns:

A java.util.Map object that contains input data mapping values associated with this endpoint. A map entry exists for each operation input value.

setOutputParameterMapping

public void setOutputParameterMapping(java.lang.String aParamName,
                                      java.lang.String aDataType,
                                      java.lang.String aMappingValue)

Sets the output data mapping value for this endpoint. An output data mapping describes the output value that is returned by the service operation that is invoked by this endpoint.

To see this method used in a code example, see the Adding a Watched Folder endpoint using the Java API quick start in the LiveCycle SDK Help.

Parameters:

aParamName - The name of the output parameter.

aDataType - The data type of the output parameter.

aMappingValue - The following options are available:

• If the service returns a single object (a single document), the pattern is %F.pdf and the source destination is sourcefilename.pdf. For example, the process introduced in this section returns a single document. As a result, the mapping type can be defined as %F.pdf (%F means use the given file name).
• If the service returns a list, the pattern is Result\%F\ and the source destination is Result\sourcefilename\source1 (output 1) and Result\sourcefilename\source2 (output 2).
• If the service returns a map, the pattern is Result\%F\ and the source destination is Result\sourcefilename\file1 and Result\sourcefilename\file2. If there is more than one object in the map, the pattern is Result\%F.pdf and the source destination is Result\sourcefilename1.pdf (output 1), Result\sourcefilenam2.pdf (output 2), and so on.

getOutputParameterMappings

public java.util.Map getOutputParameterMappings()

Retrieves the output data mapping value that is associated with this endpoint.

Returns:

A java.util.Map object that contains the output data mapping value associated with this endpoint.

setConfigParameterAsText

public void setConfigParameterAsText(java.lang.String aParamName,
                                     java.lang.String aValue)

Sets endpoint configuration values. Endpoint configuration values are implementation specific that are based on the connector that the endpoint is associated with. For example, to create a Watched Folder endpoint, you must set configuration values that are applicable to a Watched Folder endpoint. For information about adding a Watched Folder endpoint, see see Adding Watched Folder Endpoints in the LiveCycle SDK Help.

To see this method used in a code example, see the Adding a Watched Folder endpoint using the Java API quick start in the LiveCycle SDK Help.

Parameters:

aParamName - The name of the configuration value to set.

aValue - The corresponding value.

getConfigParametersAsText

public java.util.Map getConfigParametersAsText()

Retrieves configuration values that are applicable to an endpoint. Endpoint configuration values are implementation specific that are based on the connector that the endpoint is associated with. For example, a Watched Folder endpoint has different configuration values from those required by an Email endpoint. For information about configuration values that are specific to an endpoint, see see Managing Endpoints in the LiveCycle SDK Help.

Returns:

A java.util.Map object that contains configuration values.

setOperationName

public void setOperationName(java.lang.String aOperationName)

Sets the the operation name that is invoked using this endpoint. For SOAP,EJB, and Remoting endpoints, specify a wildcard character (*).

To see this method used in a code example, see the Adding a Watched Folder endpoint using the Java API in the LiveCycle SDK Help.

Parameters:

aOperationName - The name of the operation that is invoked.

getOperationName

public java.lang.String getOperationName()

Retrieves the operation name that is invoked by this endpoint.

Returns:

A string value that specifies the operation that is invoked.

setEnabled

public void setEnabled(boolean aEnabled)

Sets a flag that specifies whether the endpoint is enabled. Specify the value true to enable the endpoint. You can also enable an endpoint by invoking the EndpointRegistryClient object's enable method.

Parameters:

aEnabled - A boolean value that specifies if the endpoint is enabled.

See Also:

enable

isEnabled

public boolean isEnabled()

Retrives a value that specifies whether the endpoint is enabled.

Returns:

A boolean value that specifies whether the endpoint is enabled. The value true means that the endpoint is enabled.

getDescription

public java.lang.String getDescription()

Retrieves a description of the endpoint.

Returns:

A string value that specifies a description of the endpoint.

setDescription

public void setDescription(java.lang.String aDescription)

Sets the description of the endpoint.

To see this method used in a code example, see the Adding a Watched Folder endpoint using the Java API in the LiveCycle SDK Help.

Parameters:

aDescription - A string value that specifies the description of the endpoint.