|
|||||||||||||||||||
Source file | Conditionals | Statements | Methods | TOTAL | |||||||||||||||
RequestDirectives.java | 0% | 0% | 0% | 0% |
|
1 |
/*
|
|
2 |
* ====================================================================
|
|
3 |
*
|
|
4 |
* The Apache Software License, Version 1.1
|
|
5 |
*
|
|
6 |
* Copyright (c) 2003 The Apache Software Foundation. All rights
|
|
7 |
* reserved.
|
|
8 |
*
|
|
9 |
* Redistribution and use in source and binary forms, with or without
|
|
10 |
* modification, are permitted provided that the following conditions
|
|
11 |
* are met:
|
|
12 |
*
|
|
13 |
* 1. Redistributions of source code must retain the above copyright
|
|
14 |
* notice, this list of conditions and the following disclaimer.
|
|
15 |
*
|
|
16 |
* 2. Redistributions in binary form must reproduce the above copyright
|
|
17 |
* notice, this list of conditions and the following disclaimer in
|
|
18 |
* the documentation and/or other materials provided with the
|
|
19 |
* distribution.
|
|
20 |
*
|
|
21 |
* 3. The end-user documentation included with the redistribution, if
|
|
22 |
* any, must include the following acknowlegement:
|
|
23 |
* "This product includes software developed by the
|
|
24 |
* Apache Software Foundation (http://www.apache.org/)."
|
|
25 |
* Alternately, this acknowlegement may appear in the software itself,
|
|
26 |
* if and wherever such third-party acknowlegements normally appear.
|
|
27 |
*
|
|
28 |
* 4. The names "The Jakarta Project", "Cactus" and "Apache Software
|
|
29 |
* Foundation" must not be used to endorse or promote products
|
|
30 |
* derived from this software without prior written permission. For
|
|
31 |
* written permission, please contact apache@apache.org.
|
|
32 |
*
|
|
33 |
* 5. Products derived from this software may not be called "Apache"
|
|
34 |
* nor may "Apache" appear in their names without prior written
|
|
35 |
* permission of the Apache Group.
|
|
36 |
*
|
|
37 |
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
|
|
38 |
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
|
39 |
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
|
40 |
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
|
|
41 |
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
|
42 |
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
|
43 |
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
|
|
44 |
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
|
|
45 |
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
|
46 |
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
|
|
47 |
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
48 |
* SUCH DAMAGE.
|
|
49 |
* ====================================================================
|
|
50 |
*
|
|
51 |
* This software consists of voluntary contributions made by many
|
|
52 |
* individuals on behalf of the Apache Software Foundation. For more
|
|
53 |
* information on the Apache Software Foundation, please see
|
|
54 |
* <http://www.apache.org/>.
|
|
55 |
*
|
|
56 |
*/
|
|
57 |
package org.apache.cactus;
|
|
58 |
|
|
59 |
|
|
60 |
/**
|
|
61 |
* Encapsulates the Cactus-specific parameters added to a request.
|
|
62 |
*
|
|
63 |
* <p>
|
|
64 |
* <strong>WARNING</strong><br/>
|
|
65 |
* This interface is not intended for use by API clients. It may be altered in
|
|
66 |
* backwards-incompatible ways and even moved or removed at any time without
|
|
67 |
* further notice.
|
|
68 |
* </p>
|
|
69 |
*
|
|
70 |
* @author <a href="mailto:ndlesiecki@apache.org>Nicholas Lesiecki</a>
|
|
71 |
* @author <a href="mailto:cmlenz@apache.org>Christopher Lenz</a>
|
|
72 |
*
|
|
73 |
* @version $Id: RequestDirectives.java,v 1.3 2003/07/09 16:36:06 cmlenz Exp $
|
|
74 |
*/
|
|
75 |
public class RequestDirectives |
|
76 |
{ |
|
77 |
|
|
78 |
/**
|
|
79 |
* The WebRequest that the directives modifies.
|
|
80 |
*/
|
|
81 |
private WebRequest underlyingRequest;
|
|
82 |
|
|
83 |
/**
|
|
84 |
* @param theRequest The WebRequest to read directives from or
|
|
85 |
* apply directives to.
|
|
86 |
*/
|
|
87 | 0 |
public RequestDirectives(WebRequest theRequest)
|
88 |
{ |
|
89 | 0 |
this.underlyingRequest = theRequest;
|
90 |
} |
|
91 |
|
|
92 |
/**
|
|
93 |
* @param theName name of the test class.
|
|
94 |
*/
|
|
95 | 0 |
public void setClassName(String theName) |
96 |
{ |
|
97 | 0 |
addDirective(HttpServiceDefinition.CLASS_NAME_PARAM, theName); |
98 |
} |
|
99 |
|
|
100 |
/**
|
|
101 |
* @param theName The name of the wrapped test.
|
|
102 |
*/
|
|
103 | 0 |
public void setWrappedTestName(String theName) |
104 |
{ |
|
105 | 0 |
addDirective(HttpServiceDefinition.WRAPPED_CLASS_NAME_PARAM, theName); |
106 |
} |
|
107 |
|
|
108 |
/**
|
|
109 |
* @param theName name of the test method to execute.
|
|
110 |
*/
|
|
111 | 0 |
public void setMethodName(String theName) |
112 |
{ |
|
113 | 0 |
addDirective(HttpServiceDefinition.METHOD_NAME_PARAM, theName); |
114 |
} |
|
115 |
|
|
116 |
/**
|
|
117 |
* @param theService The service to request of the redirector.
|
|
118 |
*/
|
|
119 | 0 |
public void setService(ServiceEnumeration theService) |
120 |
{ |
|
121 | 0 |
addDirective(HttpServiceDefinition.SERVICE_NAME_PARAM, |
122 |
theService.toString()); |
|
123 |
} |
|
124 |
|
|
125 |
/**
|
|
126 |
* @param isAutoSession A "boolean string" indicating
|
|
127 |
* whether or not to use the
|
|
128 |
* autoSession option.
|
|
129 |
*/
|
|
130 | 0 |
public void setAutoSession(String isAutoSession) |
131 |
{ |
|
132 | 0 |
addDirective(HttpServiceDefinition.AUTOSESSION_NAME_PARAM, |
133 |
isAutoSession); |
|
134 |
} |
|
135 |
|
|
136 |
/**
|
|
137 |
* Adds a cactus-specific command to the URL of the WebRequest
|
|
138 |
* The URL is used to allow the user to send whatever he wants
|
|
139 |
* in the request body. For example a file, ...
|
|
140 |
*
|
|
141 |
* @param theName The name of the directive to add
|
|
142 |
* @param theValue The directive value
|
|
143 |
* @throws IllegalArgumentException If the directive name is invalid
|
|
144 |
*/
|
|
145 | 0 |
private void addDirective(String theName, String theValue) |
146 |
throws IllegalArgumentException
|
|
147 |
{ |
|
148 | 0 |
if (!theName.startsWith(HttpServiceDefinition.COMMAND_PREFIX))
|
149 |
{ |
|
150 | 0 |
throw new IllegalArgumentException("Cactus directives must begin" |
151 |
+ " with [" + HttpServiceDefinition.COMMAND_PREFIX
|
|
152 |
+ "]. The offending directive was [" + theName + "]"); |
|
153 |
} |
|
154 | 0 |
underlyingRequest.addParameter(theName, theValue, |
155 |
WebRequest.GET_METHOD); |
|
156 |
} |
|
157 |
|
|
158 |
} |
|
159 |
|
|