Coverage Report - org.apache.tapestry.engine.ServiceEncoder
 
Classes in this File Line Coverage Branch Coverage Complexity
ServiceEncoder
N/A
N/A
1
 
 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  
  * @since 4.0
 21  
  */
 22  
 public interface ServiceEncoder
 23  
 {
 24  
 
 25  
     /**
 26  
      * Invoked by the {@link org.apache.tapestry.services.LinkFactory} to
 27  
      * encode the request. Encoding is the process of modifying the encoding
 28  
      * object to represent the same data in a different format; the canoncial
 29  
      * example is to replace the
 30  
      * {@link org.apache.tapestry.services.ServiceConstants#PAGE}and
 31  
      * {@link org.apache.tapestry.services.ServiceConstants#SERVICE}query
 32  
      * parameters with a servlet path (i.e., "/Home.html", if the ".html"
 33  
      * extension is mapped to the page service).
 34  
      * <p>
 35  
      * The {@link org.apache.tapestry.services.LinkFactory}&nbsp;iterates over
 36  
      * a collection of encoders, stopping once the ServiceRequestEncoding is
 37  
      * modified in any way.
 38  
      */
 39  
 
 40  
     void encode(ServiceEncoding encoding);
 41  
 
 42  
     /**
 43  
      * Invoked to decode a request. The encoder is responsible for recognizing a
 44  
      * request it may have encoded, and for restoring any query parameters is
 45  
      * may have removed.
 46  
      */
 47  
 
 48  
     void decode(ServiceEncoding encoding);
 49  
 }