org.kuali.rice.ksb.api.bus
Interface ServiceConfiguration

All Superinterfaces:

Serializable

All Known Implementing Classes:

AbstractServiceConfiguration, JavaServiceConfiguration, RestServiceConfiguration, SoapServiceConfiguration

public interface ServiceConfiguration
extends Serializable

An interface which defines common configuration information for all services. Specific implementations might add additional configuration attributes which are appropriate for their given domain or service configuration method.

Author:

Kuali Rice Team (rice.collab@kuali.org)

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	isBasicAuthentication() Returns whether the service is secured with basic authentication
boolean	isQueue() Return true if this service uses queue-style messaging, false if it uses topic-style messaging.

Method Detail

getServiceName

QName getServiceName()

Returns the qualified name for this service.

Returns:

the qualified name for this service, should never be null

getEndpointUrl

URL getEndpointUrl()

Returns the URL of the endpoint which provides this service.

Returns:

the endpoint URL of the service, should never be null

getInstanceId

String getInstanceId()

Returns the id of the specific instance of the application which owns this service.

Returns:

the id of the specific instance of the application which owns this service, should never be null

getApplicationId

String getApplicationId()

Returns the id of the application which owns this service.

Returns:

the id of the application which owns this service, should never be null

getServiceVersion

String getServiceVersion()

Returns the version of this service.

Returns:

the version of this service, should never be null

getType

String getType()

Returns the type of this service.

Returns:

the type of this service, should never be null

isQueue

boolean isQueue()

Return true if this service uses queue-style messaging, false if it uses topic-style messaging.

Returns:

true if this service uses queue-style messaging, false if it uses topic-style messaging

getPriority

Integer getPriority()

Returns the processing priority for messages that are sent to this service.

Returns:

the message processing priority for this service

getRetryAttempts

Integer getRetryAttempts()

Returns the retry attempts to use when processing messages sent to this service.

Returns:

the retry attempts for this service

getMillisToLive

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.

Returns:

the maximum lifetime for this message, if null then this message has an infinite lifetime

getMessageExceptionHandler

String getMessageExceptionHandler()

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.

Returns:

the name of the message exception handler for this service, or null if the default handler should be used

getBusSecurity

Boolean getBusSecurity()

Returns true if this service is secured by standard KSB security features.

Returns:

true if this service is secured, false otherwise

getCredentialsType

CredentialsType getCredentialsType()

Returns the type of security credentials that should be used when attempting to authorize access to this service.

Returns:

the type of security credentials to use when access this service

isBasicAuthentication

Boolean isBasicAuthentication()

Returns whether the service is secured with basic authentication

Since:

2.1.3