Coverage Report

Coverage Report - org.kuali.rice.ksb.api.bus.ServiceConfiguration

Classes in this File

 package org.kuali.rice.ksb.api.bus;
 
 import java.io.Serializable;
 import java.net.URL;
 
 import javax.xml.namespace.QName;
 
 import org.kuali.rice.core.api.security.credentials.CredentialsType;
 
 /**
  * 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)
  *
  */
 public interface ServiceConfiguration extends Serializable {
 
         /**
          * Returns the qualified name for this service.
          * 
          * @return the qualified name for this service, should never be null
          */
         QName getServiceName();
         
         /**
          * Returns the URL of the endpoint which provides this service.
          * 
          * @return the endpoint URL of the service, should never be null
          */
         URL getEndpointUrl();
 
     /**
          * Returns the id of the specific instance of the application which owns this service.
          *
          * @return the id of the specific instance of the application which owns this service, should never
          * be null
      */
     String getInstanceId();
 
         /**
          * Returns the id of the application which owns this service.
          * 
          * @return the id of the application which owns this service, should never
          * be null
          */
         String getApplicationId();
         
         /**
          * Returns the version of this service.
          * 
          * @return the version of this service, should never be null
          */
         String getServiceVersion();
         
         /**
          * Returns the type of this service.
          * 
          * @return the type of this service, should never be null
          */
         String getType();
         
         /**
          * Return true if this service uses queue-style messaging, false if it uses
          * topic-style messaging.
          * 
          * @return true if this service uses queue-style messaging, false if it uses
          * topic-style messaging
          */
         boolean isQueue();
         
         /**
          * Returns the processing priority for messages that are sent to this service.
          * 
          * @return the message processing priority for this service
          */
         Integer getPriority();
         
         /**
          * Returns the retry attempts to use when processing messages sent to this
          * service.
          * 
          * @return the retry attempts for this service
          */
         Integer getRetryAttempts();
         
         /**
          * 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.
          *  
          * @return the maximum lifetime for this message, if null then this message has
          * an infinite lifetime
          */
         Long getMillisToLive();
         
         /**
          * 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.
          * 
          * @return the name of the message exception handler for this service, or
          * null if the default handler should be used
          */
         String getMessageExceptionHandler();
         
         /**
          * Returns true if this service is secured by standard KSB security features.
          * 
          * @return true if this service is secured, false otherwise
          */
         Boolean getBusSecurity();
         
         /**
          * Returns the type of security credentials that should be used when
          * attempting to authorize access to this service.
          * 
          * @return the type of security credentials to use when access this service
          */
         CredentialsType getCredentialsType();
 
         /**
          * Returns the name of the cache manager to use. If null or blank then caching is effectively
      * disabled for this service.
          *
          * @return the cache manager name or null
          */
     String getCacheManager();
 }

1		package org.kuali.rice.ksb.api.bus;
2
3		import java.io.Serializable;
4		import java.net.URL;
5
6		import javax.xml.namespace.QName;
7
8		import org.kuali.rice.core.api.security.credentials.CredentialsType;
9
10		/**
11		* An interface which defines common configuration information for all services.
12		* Specific implementations might add additional configuration attributes which
13		* are appropriate for their given domain or service configuration method.
14		*
15		* @author Kuali Rice Team (rice.collab@kuali.org)
16		*
17		*/
18		public interface ServiceConfiguration extends Serializable {
19
20		/**
21		* Returns the qualified name for this service.
22		*
23		* @return the qualified name for this service, should never be null
24		*/
25		QName getServiceName();
26
27		/**
28		* Returns the URL of the endpoint which provides this service.
29		*
30		* @return the endpoint URL of the service, should never be null
31		*/
32		URL getEndpointUrl();
33
34		/**
35		* Returns the id of the specific instance of the application which owns this service.
36		*
37		* @return the id of the specific instance of the application which owns this service, should never
38		* be null
39		*/
40		String getInstanceId();
41
42		/**
43		* Returns the id of the application which owns this service.
44		*
45		* @return the id of the application which owns this service, should never
46		* be null
47		*/
48		String getApplicationId();
49
50		/**
51		* Returns the version of this service.
52		*
53		* @return the version of this service, should never be null
54		*/
55		String getServiceVersion();
56
57		/**
58		* Returns the type of this service.
59		*
60		* @return the type of this service, should never be null
61		*/
62		String getType();
63
64		/**
65		* Return true if this service uses queue-style messaging, false if it uses
66		* topic-style messaging.
67		*
68		* @return true if this service uses queue-style messaging, false if it uses
69		* topic-style messaging
70		*/
71		boolean isQueue();
72
73		/**
74		* Returns the processing priority for messages that are sent to this service.
75		*
76		* @return the message processing priority for this service
77		*/
78		Integer getPriority();
79
80		/**
81		* Returns the retry attempts to use when processing messages sent to this
82		* service.
83		*
84		* @return the retry attempts for this service
85		*/
86		Integer getRetryAttempts();
87
88		/**
89		* Returns the maximum amount of milliseconds a message to this service can
90		* live and attempt to be processed successfully by this service before it's
91		* forced into processing by it's exception handler.
92		*
93		* @return the maximum lifetime for this message, if null then this message has
94		* an infinite lifetime
95		*/
96		Long getMillisToLive();
97
98		/**
99		* Returns the name of the exception handler to invoke whenever messages to
100		* this service fail to be sent. If null, the default message exception
101		* handler will be used.
102		*
103		* @return the name of the message exception handler for this service, or
104		* null if the default handler should be used
105		*/
106		String getMessageExceptionHandler();
107
108		/**
109		* Returns true if this service is secured by standard KSB security features.
110		*
111		* @return true if this service is secured, false otherwise
112		*/
113		Boolean getBusSecurity();
114
115		/**
116		* Returns the type of security credentials that should be used when
117		* attempting to authorize access to this service.
118		*
119		* @return the type of security credentials to use when access this service
120		*/
121		CredentialsType getCredentialsType();
122
123		/**
124		* Returns the name of the cache manager to use. If null or blank then caching is effectively
125		* disabled for this service.
126		*
127		* @return the cache manager name or null
128		*/
129		String getCacheManager();
130		}