public class EndpointDefinition
extends java.lang.Object
Modifier and Type | Class and Description |
---|---|
static class |
EndpointDefinition.Address
Deprecated.
use the
AddressDefinition instead |
static class |
EndpointDefinition.Defaults
The defaults for the endpoint parameters
|
static class |
EndpointDefinition.Type
The enum that defines the possible endpoint types
|
Constructor and Description |
---|
EndpointDefinition()
Constructs an endpoint definition to be embedded into a proxy service
|
EndpointDefinition(java.lang.String id)
Constructs a named endpoint definition that can be referred in proxy services with the given identifier
|
Modifier and Type | Method and Description |
---|---|
void |
addAddress(AddressDefinition addressDefinition)
Adds an address definition into the endpoint definition
|
void |
addAddress(EndpointDefinition.Address a)
Deprecated.
use the
EndpointDefinition.addAddress(AddressDefinition) instead |
void |
addProperty(java.lang.String key,
java.lang.String value)
Adds a property into the endpoint properties map
|
java.util.List |
getAddresses()
Gets the list of addresses associated with the endpoint definition
|
long |
getGracePeriod()
Gets the grace period of the endpoint
|
java.lang.String |
getId()
Gets the identifier of the endpoint definition
|
long |
getInitialDuration()
Gets the initial suspend duration in milliseconds for a suspend error for this endpoint
|
int |
getKeepalive()
Gives the keepalive time of the endpoint in milliseconds, time an idle connection opened to this endpoint should
be kept alive for possible re-use
|
long |
getMaximumDuration()
Gets the maximum suspend duration of this endpoint
|
double |
getProgressionFactor()
Gets the suspend progression factor for any consecutive suspends of this endpoint
|
java.util.Map |
getProperties()
Gets the complete properties map of the endpoint
|
java.lang.String |
getProxyID()
Sets the identifier of the proxy service to which this endpoint belongs to if it is an embedded endpoint
|
java.lang.String |
getSafeToRetryErrorCodes()
Gets the list od safe to retry error codes as a comma separated strings
|
java.lang.String |
getSuspendErrorIndicationCodes()
Gets the set of suspend error indication codes as a comma separated string
|
java.lang.String |
getTemporaryErrorIndicationCodes()
Gets the set of temporary error indication codes as a comma separated string
|
int |
getTimeout()
Gives the timeout of the endpoint in milliseconds, this might be bound to the transport level timeout if there
is any.
|
EndpointDefinition.Type |
getType()
Gets the type of the endpoint
|
boolean |
isShared()
Whether this endpoint is shared out of the deployment unit to which this endpoint belongs to
|
void |
setGracePeriod(long gracePeriod)
Sets the grace period of the endpoint
|
void |
setInitialDuration(long initialDuration)
Sets the initial suspend duration in milliseconds for this endpoint
|
void |
setKeepalive(int keepalive)
Sets the keepalive time of the endpoint in milliseconds, time an idle connection opened to this endpoint should
be kept alive for possible re-use
|
void |
setMaximumDuration(long maximumDuration)
Sets the maximum suspend duration in milliseconds of this endpoint
|
void |
setProgressionFactor(double progressionFactor)
Sets the suspend progression factor for any consecutive suspends of this endpoint
|
void |
setProxyID(java.lang.String proxyID)
Gives the identifier of the proxy service to which this endpoint belongs to if it is an embedded endpoint
|
void |
setSafeToRetryErrorCodes(java.lang.String safeToRetryErrorCodes)
Sets the list of safe to retry error codes as a comma separated strings
|
void |
setShared(boolean shared)
Sets whether this endpoint is shared out of the deployment unit to which this endpoint belongs to
|
void |
setSuspendErrorIndicationCodes(java.lang.String suspendErrorIndicationCodes)
Sets the set of suspend error indication codes as a comma separated string
|
void |
setTemporaryErrorIndicationCodes(java.lang.String temporaryErrorIndicationCodes)
Sets the set of temporary error indication codes as a comma separated string
|
void |
setTimeout(int timeout)
Sets the timeout of the endpoint in milliseconds, this might be bound to the transport level timeout if there
is any.
|
void |
setType(EndpointDefinition.Type type)
Sets the type of the endpoint
|
void |
setType(java.lang.String type)
Deprecated.
|
public EndpointDefinition()
public EndpointDefinition(java.lang.String id)
id
- the identifier of the endpoint definitionpublic java.lang.String getId()
public void addAddress(AddressDefinition addressDefinition)
addressDefinition
- the address definition to be added to the endpoint@Deprecated public void addAddress(EndpointDefinition.Address a)
EndpointDefinition.addAddress(AddressDefinition)
insteada
- address to be addedpublic java.util.List getAddresses()
public java.lang.String getSafeToRetryErrorCodes()
public void setSafeToRetryErrorCodes(java.lang.String safeToRetryErrorCodes)
safeToRetryErrorCodes
- list of safe to retry error codes as a comma separated string@Deprecated public void setType(java.lang.String type)
EndpointDefinition.setType(org.adroitlogic.ultraesb.api.management.EndpointDefinition.Type)
insteadtype
- the string representation of the typepublic EndpointDefinition.Type getType()
public void setType(EndpointDefinition.Type type)
type
- the type of the endpointpublic long getGracePeriod()
public void setGracePeriod(long gracePeriod)
gracePeriod
- the grace period in millisecondspublic java.lang.String getTemporaryErrorIndicationCodes()
public void setTemporaryErrorIndicationCodes(java.lang.String temporaryErrorIndicationCodes)
temporaryErrorIndicationCodes
- the set of temporary error indication codes as a comma separated stringpublic long getInitialDuration()
public void setInitialDuration(long initialDuration)
initialDuration
- the initial suspend duration in milliseconds for this endpointpublic double getProgressionFactor()
public void setProgressionFactor(double progressionFactor)
progressionFactor
- the suspension progression factorpublic long getMaximumDuration()
public void setMaximumDuration(long maximumDuration)
maximumDuration
- the maximum suspend duration in millisecondspublic java.lang.String getSuspendErrorIndicationCodes()
public void setSuspendErrorIndicationCodes(java.lang.String suspendErrorIndicationCodes)
suspendErrorIndicationCodes
- the set of suspend error indication codes as a comma separated stringpublic int getTimeout()
public void setTimeout(int timeout)
timeout
- the timeout of the endpoint in millisecondspublic int getKeepalive()
public void setKeepalive(int keepalive)
keepalive
- the keepalive time in millisecondspublic void setProxyID(java.lang.String proxyID)
proxyID
- the identifier of the proxy service to which this endpoint belongs topublic java.lang.String getProxyID()
public void addProperty(java.lang.String key, java.lang.String value)
key
- the key of the property to be addedvalue
- the value of the property to be added to the endpoint mappublic java.util.Map getProperties()
Map
public boolean isShared()
public void setShared(boolean shared)
shared
- whether this endpoint is shared or not