org.kuali.rice.ksb.api.bus.support
Class AbstractServiceConfiguration

java.lang.Object
  extended by org.kuali.rice.core.api.mo.AbstractDataTransferObject
      extended by org.kuali.rice.ksb.api.bus.support.AbstractServiceConfiguration
All Implemented Interfaces:
Serializable, ModelObjectBasic, ModelObjectComplete, ServiceConfiguration
Direct Known Subclasses:
JavaServiceConfiguration, RestServiceConfiguration, SoapServiceConfiguration

public abstract class AbstractServiceConfiguration
extends AbstractDataTransferObject
implements ServiceConfiguration

See Also:
Serialized Form

Nested Class Summary
protected static class AbstractServiceConfiguration.Builder<T>
           
protected static class AbstractServiceConfiguration.Constants
          Defines some internal constants used on this class.
protected static class AbstractServiceConfiguration.Elements
          A private class which exposes constants which define the XML element names to use when this object is marshalled to XML.
 
Constructor Summary
protected AbstractServiceConfiguration()
          Constructor intended for use only by JAXB.
protected AbstractServiceConfiguration(AbstractServiceConfiguration.Builder<?> builder)
           
 
Method Summary
 String getApplicationId()
          Returns the id of the application which owns this service.
 Boolean getBusSecurity()
          Returns true if this service is secured by standard KSB security features.
 CredentialsType getCredentialsType()
          Returns the type of security credentials that should be used when attempting to authorize access to this service.
 URL getEndpointUrl()
          Returns the URL of the endpoint which provides this service.
 String getInstanceId()
          Returns the id of the specific instance of the application which owns this service.
 String getMessageExceptionHandler()
          Returns the name of the exception handler to invoke whenever messages to this service fail to be sent.
 Long getMillisToLive()
          Returns the maximum amount of milliseconds a message to this service can live and attempt to be processed successfully by this service before it's forced into processing by it's exception handler.
 Integer getPriority()
          Returns the processing priority for messages that are sent to this service.
 Integer getRetryAttempts()
          Returns the retry attempts to use when processing messages sent to this service.
 QName getServiceName()
          Returns the qualified name for this service.
 String getServiceVersion()
          Returns the version of this service.
 String getType()
          Returns the type of this service.
 boolean isQueue()
          Return true if this service uses queue-style messaging, false if it uses topic-style messaging.
 
Methods inherited from class org.kuali.rice.core.api.mo.AbstractDataTransferObject
afterUnmarshal, beforeUnmarshal, equals, hashCode, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

AbstractServiceConfiguration

protected AbstractServiceConfiguration()
Constructor intended for use only by JAXB.


AbstractServiceConfiguration

protected AbstractServiceConfiguration(AbstractServiceConfiguration.Builder<?> builder)
Method Detail

getServiceName

public QName getServiceName()
Description copied from interface: ServiceConfiguration
Returns the qualified name for this service.

Specified by:
getServiceName in interface ServiceConfiguration
Returns:
the qualified name for this service, should never be null

getEndpointUrl

public URL getEndpointUrl()
Description copied from interface: ServiceConfiguration
Returns the URL of the endpoint which provides this service.

Specified by:
getEndpointUrl in interface ServiceConfiguration
Returns:
the endpoint URL of the service, should never be null

getInstanceId

public String getInstanceId()
Description copied from interface: ServiceConfiguration
Returns the id of the specific instance of the application which owns this service.

Specified by:
getInstanceId in interface ServiceConfiguration
Returns:
the id of the specific instance of the application which owns this service, should never be null

getApplicationId

public String getApplicationId()
Description copied from interface: ServiceConfiguration
Returns the id of the application which owns this service.

Specified by:
getApplicationId in interface ServiceConfiguration
Returns:
the id of the application which owns this service, should never be null

getServiceVersion

public String getServiceVersion()
Description copied from interface: ServiceConfiguration
Returns the version of this service.

Specified by:
getServiceVersion in interface ServiceConfiguration
Returns:
the version of this service, should never be null

getType

public String getType()
Description copied from interface: ServiceConfiguration
Returns the type of this service.

Specified by:
getType in interface ServiceConfiguration
Returns:
the type of this service, should never be null

isQueue

public boolean isQueue()
Description copied from interface: ServiceConfiguration
Return true if this service uses queue-style messaging, false if it uses topic-style messaging.

Specified by:
isQueue in interface ServiceConfiguration
Returns:
true if this service uses queue-style messaging, false if it uses topic-style messaging

getPriority

public Integer getPriority()
Description copied from interface: ServiceConfiguration
Returns the processing priority for messages that are sent to this service.

Specified by:
getPriority in interface ServiceConfiguration
Returns:
the message processing priority for this service

getRetryAttempts

public Integer getRetryAttempts()
Description copied from interface: ServiceConfiguration
Returns the retry attempts to use when processing messages sent to this service.

Specified by:
getRetryAttempts in interface ServiceConfiguration
Returns:
the retry attempts for this service

getMillisToLive

public Long getMillisToLive()
Description copied from interface: ServiceConfiguration
Returns the maximum amount of milliseconds a message to this service can live and attempt to be processed successfully by this service before it's forced into processing by it's exception handler.

Specified by:
getMillisToLive in interface ServiceConfiguration
Returns:
the maximum lifetime for this message, if null then this message has an infinite lifetime

getMessageExceptionHandler

public String getMessageExceptionHandler()
Description copied from interface: ServiceConfiguration
Returns the name of the exception handler to invoke whenever messages to this service fail to be sent. If null, the default message exception handler will be used.

Specified by:
getMessageExceptionHandler in interface ServiceConfiguration
Returns:
the name of the message exception handler for this service, or null if the default handler should be used

getBusSecurity

public Boolean getBusSecurity()
Description copied from interface: ServiceConfiguration
Returns true if this service is secured by standard KSB security features.

Specified by:
getBusSecurity in interface ServiceConfiguration
Returns:
true if this service is secured, false otherwise

getCredentialsType

public CredentialsType getCredentialsType()
Description copied from interface: ServiceConfiguration
Returns the type of security credentials that should be used when attempting to authorize access to this service.

Specified by:
getCredentialsType in interface ServiceConfiguration
Returns:
the type of security credentials to use when access this service


Copyright © 2005-2012 The Kuali Foundation. All Rights Reserved.