|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Endpoint
An Endpoint
object enables you to set and retrieve endpoint information.
An endpoint associates a service operation with an available
connector, such as a WatchedFolder connector, thereby enabling
a client application to invoke the service operation by using different invocation methods.
For example, a Watched Folder endpoint enables a Watched
Folder to invoke a specific service operation.
An Endpoint
instance is not instantiated directly. Instead, an Endpoint
instance
is returned by methods such as the EndpointRegistryClient
object's
createEndpoint
method.
For information about programmatically adding an endpoint to a service,
see Managing Endpoints in the LiveCycle SDK Help.
Method Summary | |
---|---|
EndpointCategory |
getCategory()
Retrieves the endpoint category. |
ConfigParameter[] |
getConfigParameters()
Retrieves configuration parameter values for this endpoint. |
java.lang.String |
getConnectorId()
Retrieves the identifier of this endpoint's connector. |
java.lang.String |
getDescription()
Retrieves the endpoint description. |
EndpointURI |
getEndpointURI()
Retrieves the endpoint URI. |
long |
getId()
Retrieves this unique identifier of the endpoint. |
InputParameterMapping[] |
getInputParameterMappings()
Retrieves input data mappings values. |
java.lang.String |
getName()
Retrieves the unique name of this endpoint. |
java.lang.String |
getOperationName()
Retrieves the operation name that is invoked by using this endpoint. |
OutputParameterMapping[] |
getOutputParameterMappings()
Retrieves output data mapping values. |
java.lang.String |
getServiceId()
Get the service identifier for which this endpoint is associated. |
java.lang.String |
getServiceSpecificationId()
Retrieves the specification identifier of a service, identifying its contract. |
boolean |
isEnabled()
Determines if the endpoint is enabled. |
void |
setDescription(java.lang.String aDescription)
Sets a new endpoint description. |
void |
setEndpointURI(EndpointURI aEndpointUri)
Sets the endpoint URI. |
Method Detail |
---|
long getId()
java.lang.String getName()
java.lang.String getDescription()
void setDescription(java.lang.String aDescription)
aDescription
- A string value that specifies the description of the endpoint.EndpointCategory getCategory()
java.lang.String getServiceId()
java.lang.String getServiceSpecificationId()
java.lang.String getConnectorId()
EJB
, SOAP
, WatchedFolder
, Email
, Remoting
, and TaskManagerConnector
.
EndpointURI getEndpointURI()
void setEndpointURI(EndpointURI aEndpointUri) throws java.lang.Exception
aEndpointUri
- An EndpointURI
object that sets the URI for this endpoint.
java.lang.Exception
- If an invalid URI is specified.ConfigParameter[] getConfigParameters()
ConfigParameter
objects that represent configuration parameters for this endpoint.ConfigParameter
InputParameterMapping[] getInputParameterMappings()
InputParameterMapping
objects.InputParameterMapping
OutputParameterMapping[] getOutputParameterMappings()
OutputParameterMapping
objects.OutputParameterMapping
java.lang.String getOperationName()
boolean isEnabled()
true
if the endpoint is enabled; otherwise, returns false
.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |