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

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

All Implemented Interfaces:

java.io.Serializable

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

Enables the creation of a Java object that is required to modify an existing endpoint. By modifying an endpoint, you can change the behaviour of the endpoint. Consider, for example, a WatchFolder endpoint that specifies a folder that is used as the watched folder. You can programmatically modify configuration values that belong to the WatchFolder endpoint resulting in another folder functioning as the watched folder. For information about programmatically modifying endpoints, see Modifying Endpoints in the LiveCycle SDK Help.

See Also:

Serialized Form

Nested Class Summary

class	ModifyEndpointInfo.InputMapping Represents an input data mapping value that is assoicated with an endpoint.
class	ModifyEndpointInfo.OutputMapping Represents an output data mapping value that is assoicated with an endpoint.

Constructor Summary

ModifyEndpointInfo()
A constructor that creates a ModifyEndpointInfo object.

Method Summary

java.lang.String	getCategoryId() Retrieves the endpoint category identifier value.
java.util.Map	getConfigParameters() Retrieves configuration values that are applicable to an endpoint.
java.lang.String	getDescription() Retrieves a description of the endpoint.
long	getId() Retrieves the identifier value of this 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 output data mapping value that is associated with this endpoint.
boolean	isCategoryIdSet() Specifies whether the category identifier value is set.
boolean	isConfigParamsSet() Specifies whether configuration values for this endpoint are set.
boolean	isDescriptionSet() Specifies whether the endpoint description is set.
boolean	isEnabled() Retrives a value that specifies whether the endpoint is enabled.
boolean	isEnabledSet() Specifies whether the endpoint is enabled.
boolean	isInputMappingsSet() Specifies whether input data mapping values are set.
boolean	isNameSet() Specifies whether the category name is set.
boolean	isOperationNameSet() Specifies whether the operation name for this endpoint is set.
boolean	isOutputMappingsSet() Specifies whether output data mapping values are set.
void	setCategoryId(java.lang.String aId) Sets the endpoint category identifier value.
void	setConfigParameterAsText(java.lang.String aParamName, java.lang.String aValue) Sets the endpoint configuration values.
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	setId(long aId) Sets the identifier value of this endpoint.
void	setInputParameterMapping(java.lang.String aParamName, java.lang.String aParamType, java.lang.String aMappingType, java.lang.String aValue) 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 aParamType, java.lang.String aValue) Sets the output data mapping value for this endpoint.

Methods inherited from class java.lang.Object

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

Constructor Detail

ModifyEndpointInfo

public ModifyEndpointInfo()

A constructor that creates a ModifyEndpointInfo object.

Method Detail

setId

public void setId(long aId)

Sets the identifier value of this endpoint. Pass the return value the Endpoint object's getId method to this method.

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

Parameters:

aId - The identifier value of this endpoint.

See Also:

Endpoint

getId

public long getId()

Retrieves the identifier value of this endpoint.

Returns:

The identifier value of this endpoint.

setName

public void setName(java.lang.String aName)

Sets the name of this endpoint.

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 endpoint name.

isNameSet

public boolean isNameSet()

Specifies whether the category name is set.

Returns:

A boolean value that specifies whether the name is set. The value true means that the category name is set.

setCategoryId

public void setCategoryId(java.lang.String aId)

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

Parameters:

aId - The identifier value 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.

isCategoryIdSet

public boolean isCategoryIdSet()

Specifies whether the category identifier value is set.

Returns:

A boolean value that specifies whether the category identifier value is set. The value true means that the category identifier value is set.

See Also:

setCategoryId

setInputParameterMapping

public void setInputParameterMapping(java.lang.String aParamName,
                                     java.lang.String aParamType,
                                     java.lang.String aMappingType,
                                     java.lang.String aValue)

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 Modifying an endpoint using the Java API quick start in the LiveCycle SDK Help.

Parameters:

aParamName - The name of the input parameter.

aParamType - The data type of the input parameter.

aMappingType - Used to configure the input values required to invoke the service operation. Two types of 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 has to be a PDF file, you can specify *.pdf as the mapping value.

aValue - 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.

isInputMappingsSet

public boolean isInputMappingsSet()

Specifies whether input data mapping values are set.

Returns:

A boolean value that specifies whether input data mapping values are set. The value true means that input data mapping values are set.

See Also:

setInputParameterMapping

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 assoicated with an endpoint. A map entry exists for each operation input value.

setOutputParameterMapping

public void setOutputParameterMapping(java.lang.String aParamName,
                                      java.lang.String aParamType,
                                      java.lang.String aValue)

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. For information about setting an output data mapping value, see Adding Watched Folder Endpoints in the LiveCycle SDK Help.

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

Parameters:

aParamName - The name of the output parameter.

aParamType - The data type of the output parameter.

aValue - 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 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.

isOutputMappingsSet

public boolean isOutputMappingsSet()

Specifies whether output data mapping values are set.

Returns:

A boolean value that specifies whether output data mapping values are set. The value true means that output data mapping values are set.

See Also:

setOutputParameterMapping

setConfigParameterAsText

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

Sets the 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.

To see this method used in a code example, see the Modifying an 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.

getConfigParameters

public java.util.Map getConfigParameters()

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 then 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.

isConfigParamsSet

public boolean isConfigParamsSet()

Specifies whether configuration values for this endpoint are set.

Returns:

A boolean value that specifies whether configuration values are set. The value true means that configuration values are set.

See Also:

setConfigParameterAsText

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 (*).

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.

isOperationNameSet

public boolean isOperationNameSet()

Specifies whether the operation name for this endpoint is set.

Returns:

A boolean value that specifies whether the operation name is set. The value true means that the operation name is set.

See Also:

setOperationName

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. The value true means that the endpoint is enabled.

Returns:

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

isEnabledSet

public boolean isEnabledSet()

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.

See Also:

setEnabled

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.

Parameters:

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

isDescriptionSet

public boolean isDescriptionSet()

Specifies whether the endpoint description is set.

Returns:

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

See Also:

setDescription