|
|||||||||||||||||||
30 day Evaluation License registered to hlship@comcast.net Your 30 day evaluation period has expired. Please visit http://www.cenqua.com to obtain a licensed version of Clover | |||||||||||||||||||
Source file | Conditionals | Statements | Methods | TOTAL | |||||||||||||||
ServiceEncoder.java | - | - | - | - |
|
1 | // Copyright 2004, 2005 The Apache Software Foundation | |
2 | // | |
3 | // Licensed under the Apache License, Version 2.0 (the "License"); | |
4 | // you may not use this file except in compliance with the License. | |
5 | // You may obtain a copy of the License at | |
6 | // | |
7 | // http://www.apache.org/licenses/LICENSE-2.0 | |
8 | // | |
9 | // Unless required by applicable law or agreed to in writing, software | |
10 | // distributed under the License is distributed on an "AS IS" BASIS, | |
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
12 | // See the License for the specific language governing permissions and | |
13 | // limitations under the License. | |
14 | ||
15 | package org.apache.tapestry.engine; | |
16 | ||
17 | /** | |
18 | * Encapsulates the logic for encoding and decoding service requests. | |
19 | * | |
20 | * @author Howard M. Lewis Ship | |
21 | * @since 4.0 | |
22 | */ | |
23 | public interface ServiceEncoder | |
24 | { | |
25 | /** | |
26 | * Invoked by the {@link org.apache.tapestry.services.LinkFactory} to encode the request. | |
27 | * Encoding is the process of modifying the encoding object to represent the same data in a | |
28 | * different format; the canoncial example is to replace the | |
29 | * {@link org.apache.tapestry.services.ServiceConstants#PAGE}and | |
30 | * {@link org.apache.tapestry.services.ServiceConstants#SERVICE}query parameters with a servlet | |
31 | * path (i.e., "/Home.html", if the ".html" extension is mapped to the page service). | |
32 | * <p> | |
33 | * The {@link org.apache.tapestry.services.LinkFactory} iterates over a collection of | |
34 | * encoders, stopping once the ServiceRequestEncoding is modified in any way. | |
35 | */ | |
36 | ||
37 | public void encode(ServiceEncoding encoding); | |
38 | ||
39 | /** | |
40 | * Invoked to decode a request. The encoder is responsible for recognizing a request it may have | |
41 | * encoded, and for restoring any query parameters is may have removed. | |
42 | */ | |
43 | ||
44 | public void decode(ServiceEncoding encoding); | |
45 | } |
|