View Javadoc

1   /**
2    * Copyright 2005-2014 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;
17  
18  import org.kuali.rice.core.api.CoreConstants;
19  
20  /**
21   * Defines various constants that are used by or in conjunction with the KSB api.
22   * 
23   * @author Kuali Rice Team (rice.collab@kuali.org)
24   *
25   */
26  public final class KsbApiConstants {
27  
28  	/**
29  	 * The name of the KSB module
30  	 */
31  	public static final String KSB_MODULE_NAME = "ksb";
32  
33      public final static String SERVICE_PATH_SOAP = "soap/" + Namespaces.MODULE_NAME + "/" + CoreConstants.Versions.VERSION_2_0;
34  	
35  	/**
36  	 * Defines the set of out-of-the-box service types that the KSB understands.
37  	 */
38  	public static final class ServiceTypes {
39  		
40  		/**
41  		 * The service type for services that use Spring's Http Invoker to perform Java Serialization over HTTP
42  		 */
43  		public static final String HTTP_INVOKER = "httpInvoker";
44  		
45  		/**
46  		 * The service type for services that use SOAP
47  		 */
48  		public static final String SOAP = "SOAP";
49  		
50  		/**
51  		 * The service type for services that use a REST-style approach 
52  		 */
53  		public static final String REST = "REST";
54  		
55  	}
56  	
57  	/**
58  	 * Defines various namespace-related constants for the KSB.
59  	 */
60  	public static final class Namespaces {
61  		 public static final String MODULE_NAME = "ksb";
62  		/**
63  		 * The KSB namespace for version 2.x of Kuali Rice
64  		 */
65          public static final String KSB_NAMESPACE_2_0 = CoreConstants.Namespaces.ROOT_NAMESPACE_PREFIX + "/" + MODULE_NAME + "/" + CoreConstants.Versions.VERSION_2_0;
66          
67  	}
68  	
69  	private KsbApiConstants() {
70  		throw new UnsupportedOperationException("Should never be called!");
71  	}
72  	
73  }