HttpServiceDefinition


1   /* 
2    * ========================================================================
3    * 
4    * Copyright 2001-2004 The Apache Software Foundation.
5    *
6    * Licensed under the Apache License, Version 2.0 (the "License");
7    * you may not use this file except in compliance with the License.
8    * You may obtain a copy of the License at
9    * 
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   * 
12   * Unless required by applicable law or agreed to in writing, software
13   * distributed under the License is distributed on an "AS IS" BASIS,
14   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15   * See the License for the specific language governing permissions and
16   * limitations under the License.
17   * 
18   * ========================================================================
19   */
20  package org.apache.cactus.internal;
21  
22  /**
23   * Constants that define HTTP parameters required for defining a service that
24   * is performed by the <code>ServletTestRedirector</code> servlet.
25   * 
26   * @version $Id: HttpServiceDefinition.java,v 1.1 2004/05/22 11:34:47 vmassol Exp $
27   */
28  public interface HttpServiceDefinition
29  {
30      /**
31       * Prefix indicating that a String is an official Cactus command.
32       */
33      String   COMMAND_PREFIX = "Cactus_";
34  
35      /**
36       * Name of the parameter in the HTTP request that represents the unique id
37       * of the test case (to ensure that the client-side test gets the correct
38       * results).
39       */
40      String   TEST_ID_PARAM = COMMAND_PREFIX + "UniqueId";
41  
42      /**
43       * Name of the parameter in the HTTP request that represents the name of the
44       * Test class to call. The name is voluntarily long so that it will not
45       * clash with a user-defined parameter.
46       */
47      String   CLASS_NAME_PARAM = COMMAND_PREFIX + "TestClass";
48  
49      /**
50       * Name of the parameter in the HTTP request that represents an optional
51       * Test being wrapped by the class represented by CLASS_NAME_PARAM.
52       */
53      String   WRAPPED_CLASS_NAME_PARAM = COMMAND_PREFIX + "WrappedTestClass";
54  
55      /**
56       * Name of the parameter in the HTTP request that represents the name of the
57       * Test method to call. The name is voluntarily long so that it will not
58       * clash with a user-defined parameter.
59       */
60      String   METHOD_NAME_PARAM = COMMAND_PREFIX + "TestMethod";
61  
62      /**
63       * Name of the parameter in the HTTP request that specify if a session
64       * should be automatically created for the user or not.
65       */
66      String   AUTOSESSION_NAME_PARAM = COMMAND_PREFIX + "AutomaticSession";
67  
68      /**
69       * Name of the parameter in the HTTP request that specify the service asked
70       * to the Redirector Servlet. It can be either to ask the Redirector Servlet
71       * to call the test method or to ask the Redirector Servlet to return the
72       * result of the last test.
73       *
74       * @see ServiceEnumeration
75       */
76      String   SERVICE_NAME_PARAM = COMMAND_PREFIX + "Service";
77  }
78
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags