Coverage Report

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

Classes in this File

 /**
  * Copyright 2005-2011 The Kuali Foundation
  *
  * Licensed under the Educational Community License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
  * http://www.opensource.org/licenses/ecl2.php
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
 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		/**
2		* Copyright 2005-2011 The Kuali Foundation
3		*
4		* Licensed under the Educational Community License, Version 2.0 (the "License");
5		* you may not use this file except in compliance with the License.
6		* You may obtain a copy of the License at
7		*
8		* http://www.opensource.org/licenses/ecl2.php
9		*
10		* Unless required by applicable law or agreed to in writing, software
11		* distributed under the License is distributed on an "AS IS" BASIS,
12		* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13		* See the License for the specific language governing permissions and
14		* limitations under the License.
15		*/
16		package org.kuali.rice.ksb.api.bus;
17
18		import java.io.Serializable;
19		import java.net.URL;
20
21		import javax.xml.namespace.QName;
22
23		import org.kuali.rice.core.api.security.credentials.CredentialsType;
24
25		/**
26		* An interface which defines common configuration information for all services.
27		* Specific implementations might add additional configuration attributes which
28		* are appropriate for their given domain or service configuration method.
29		*
30		* @author Kuali Rice Team (rice.collab@kuali.org)
31		*
32		*/
33		public interface ServiceConfiguration extends Serializable {
34
35		/**
36		* Returns the qualified name for this service.
37		*
38		* @return the qualified name for this service, should never be null
39		*/
40		QName getServiceName();
41
42		/**
43		* Returns the URL of the endpoint which provides this service.
44		*
45		* @return the endpoint URL of the service, should never be null
46		*/
47		URL getEndpointUrl();
48
49		/**
50		* Returns the id of the specific instance of the application which owns this service.
51		*
52		* @return the id of the specific instance of the application which owns this service, should never
53		* be null
54		*/
55		String getInstanceId();
56
57		/**
58		* Returns the id of the application which owns this service.
59		*
60		* @return the id of the application which owns this service, should never
61		* be null
62		*/
63		String getApplicationId();
64
65		/**
66		* Returns the version of this service.
67		*
68		* @return the version of this service, should never be null
69		*/
70		String getServiceVersion();
71
72		/**
73		* Returns the type of this service.
74		*
75		* @return the type of this service, should never be null
76		*/
77		String getType();
78
79		/**
80		* Return true if this service uses queue-style messaging, false if it uses
81		* topic-style messaging.
82		*
83		* @return true if this service uses queue-style messaging, false if it uses
84		* topic-style messaging
85		*/
86		boolean isQueue();
87
88		/**
89		* Returns the processing priority for messages that are sent to this service.
90		*
91		* @return the message processing priority for this service
92		*/
93		Integer getPriority();
94
95		/**
96		* Returns the retry attempts to use when processing messages sent to this
97		* service.
98		*
99		* @return the retry attempts for this service
100		*/
101		Integer getRetryAttempts();
102
103		/**
104		* Returns the maximum amount of milliseconds a message to this service can
105		* live and attempt to be processed successfully by this service before it's
106		* forced into processing by it's exception handler.
107		*
108		* @return the maximum lifetime for this message, if null then this message has
109		* an infinite lifetime
110		*/
111		Long getMillisToLive();
112
113		/**
114		* Returns the name of the exception handler to invoke whenever messages to
115		* this service fail to be sent. If null, the default message exception
116		* handler will be used.
117		*
118		* @return the name of the message exception handler for this service, or
119		* null if the default handler should be used
120		*/
121		String getMessageExceptionHandler();
122
123		/**
124		* Returns true if this service is secured by standard KSB security features.
125		*
126		* @return true if this service is secured, false otherwise
127		*/
128		Boolean getBusSecurity();
129
130		/**
131		* Returns the type of security credentials that should be used when
132		* attempting to authorize access to this service.
133		*
134		* @return the type of security credentials to use when access this service
135		*/
136		CredentialsType getCredentialsType();
137
138		/**
139		* Returns the name of the cache manager to use. If null or blank then caching is effectively
140		* disabled for this service.
141		*
142		* @return the cache manager name or null
143		*/
144		String getCacheManager();
145		}