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