org.apache.woden.wsdl20.extensions.http
Class HTTPLocationTemplate

java.lang.Object
  extended by org.apache.woden.wsdl20.extensions.http.HTTPLocationTemplate

public class HTTPLocationTemplate
extends java.lang.Object

This class represents the curly brace template syntax used within the whttp:location extension attribute and the {http location} extension property. That is, it represents an element cited in the HTTP location by enclosing the element's local name within curly braces. There are two types of template syntax; encoded templates (which must be percent-encoded in the resulting URI) have the syntax "{localname}", whereas raw templates (which are not percent-encoded) have the exclamated syntax "{!localname}".

For example, in the encoded template "{accountBalance}", accountBalance is the local name of an element from the instance data. This template could appear in an HTTP location such as "?balance={accountBalance}", which represents a URI query string with one query parameter, 'balance', and a templated parameter value which will be substituted with the value of the element <accountBalance> from the instance data.

This class has a single constructor which takes three parameters that indicate the local name of the element cited in the template, whether the template is encoded or raw and whether the template appears in the path or the query string. This template is immutable (i.e. there is no setter method to change the template represented by this class).

This class has the following characteristics:

Author:
John Kaputin (jkaputin@apache.org)

Constructor Summary
HTTPLocationTemplate(java.lang.String name, boolean isEncoded, boolean isQuery)
          This constructor creates an HTTPLocationTemplate object.
 
Method Summary
 java.lang.String getName()
           
 java.lang.String getValue()
           
 boolean isEncoded()
           
 boolean isQuery()
           
 void setValue(java.lang.String value)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

HTTPLocationTemplate

public HTTPLocationTemplate(java.lang.String name,
                            boolean isEncoded,
                            boolean isQuery)
This constructor creates an HTTPLocationTemplate object.

Parameters:
name - a String representing the local name of the element cited by this template.
isEncoded - a boolean value 'true' if it is an encoded template or 'false' if it is a raw template.
isQuery - a boolean value 'true' if the template appears in the query string or 'false' if it appears in the path (i.e. before the first occurrence of "?").
Method Detail

getName

public java.lang.String getName()

getValue

public java.lang.String getValue()

setValue

public void setValue(java.lang.String value)

isEncoded

public boolean isEncoded()

isQuery

public boolean isQuery()


Copyright © 2007. All Rights Reserved.