org.xins.server

Class XSLTCallingConvention

java.lang.Object

org.xins.common.manageable.Manageable

org.xins.server.StandardCallingConvention

org.xins.server.XSLTCallingConvention

public class XSLTCallingConvention
extends StandardCallingConvention

XSLT calling convention. The XSLT calling convention input is the same as for the standard calling convention. The XSLT calling convention output is the result of the XML normally returned by the standard calling convention and the specified XSLT. The Mime type of the return data can be specified in the XSLT using the media-type or method attribute of the XSL output element. More information about the XSLT calling convention can be found in the user guide.

Version:

$Revision: 1.63 $ $Date: 2013/01/18 14:21:24 $

Author:

Anthony Goubard, Ernst de Haan

Nested Class Summary

Nested classes/interfaces inherited from class org.xins.common.manageable.Manageable

Manageable.State

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	CLEAR_TEMPLATE_CACHE_PARAMETER The name of the input parameter used to clear the template cache.
protected static String	TEMPLATE_PARAMETER The name of the input parameter that specifies the location of the XSLT template to use.
protected static String	TEMPLATES_CACHE_PROPERTY The name of the runtime property that defines if the templates should be cached.

Fields inherited from class org.xins.server.StandardCallingConvention

RESPONSE_CONTENT_TYPE, RESPONSE_ENCODING

Fields inherited from class org.xins.common.manageable.Manageable

BOOTSTRAPPED, BOOTSTRAPPING, DEINITIALIZING, INITIALIZING, UNUSABLE, USABLE

Constructor Summary

Constructors

Constructor and Description
XSLTCallingConvention() Constructs a new XSLTCallingConvention object.

Method Summary

Methods

Modifier and Type	Method and Description
protected FunctionRequest	convertRequestImpl(HttpServletRequest httpRequest) Converts an HTTP request to a XINS request (implementation method).
protected void	convertResultImpl(FunctionResult xinsResult, HttpServletResponse httpResponse, Map<String,Object> backpack) Converts a XINS result to an HTTP response (implementation method).
protected API	getAPI() Determines the current API.
protected String[]	getSupportedMethods() Determines which HTTP methods are supported for function invocations.
protected String[]	getSupportedMethods(HttpServletRequest request) Determines which HTTP methods are supported for function invocations, for the specified request.
protected void	initImpl(Map<String,String> runtimeProperties) Performs the initialization procedure (actual implementation).
protected Element	parseXMLRequest(HttpServletRequest httpRequest) Parses XML from the specified HTTP request and checks that the content type is correct.
protected Element	parseXMLRequest(HttpServletRequest httpRequest, boolean checkType) Parses XML from the specified HTTP request and optionally checks that the content type is correct.

Methods inherited from class org.xins.server.StandardCallingConvention

matches

Methods inherited from class org.xins.common.manageable.Manageable

assertUsable, bootstrap, bootstrapImpl, deinit, deinitImpl, getState, init, isBootstrapped, isUsable

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TEMPLATES_CACHE_PROPERTY

protected static final String TEMPLATES_CACHE_PROPERTY

The name of the runtime property that defines if the templates should be cached. Should be either "true" or "false". By default the cache is enabled.

See Also:

Constant Field Values

TEMPLATE_PARAMETER

protected static final String TEMPLATE_PARAMETER

The name of the input parameter that specifies the location of the XSLT template to use.

See Also:

Constant Field Values

CLEAR_TEMPLATE_CACHE_PARAMETER

protected static final String CLEAR_TEMPLATE_CACHE_PARAMETER

The name of the input parameter used to clear the template cache.

See Also:

Constant Field Values

Constructor Detail

XSLTCallingConvention

public XSLTCallingConvention()

Constructs a new XSLTCallingConvention object.

Method Detail

initImpl

protected void initImpl(Map<String,String> runtimeProperties)
                 throws MissingRequiredPropertyException,
                        InvalidPropertyValueException,
                        InitializationException

Description copied from class: Manageable

Performs the initialization procedure (actual implementation). When this method is called from Manageable.init(Map), the state and the argument will have been checked and the state will have been set to Manageable.INITIALIZING.

The implementation of this method in class Manageable is empty.

Overrides:

initImpl in class Manageable

Parameters:

runtimeProperties - the initialization properties, not null.

Throws:

MissingRequiredPropertyException - if a required property is not given.

InvalidPropertyValueException - if the value of a certain property is invalid.

InitializationException - if the initialization failed, for any other reason.

convertRequestImpl

protected FunctionRequest convertRequestImpl(HttpServletRequest httpRequest)
                                      throws InvalidRequestException,
                                             FunctionNotSpecifiedException

Description copied from class: StandardCallingConvention

Converts an HTTP request to a XINS request (implementation method). This method should only be called from class CallingConvention. Only then it is guaranteed that the httpRequest argument is not null.

Overrides:

convertRequestImpl in class StandardCallingConvention

Parameters:

httpRequest - the HTTP request, will not be null.

Returns:

the XINS request object, never null.

Throws:

InvalidRequestException - if the request is considerd to be invalid.

FunctionNotSpecifiedException - if the request does not indicate the name of the function to execute.

convertResultImpl

protected void convertResultImpl(FunctionResult xinsResult,
                     HttpServletResponse httpResponse,
                     Map<String,Object> backpack)
                          throws IOException

Description copied from class: StandardCallingConvention

Converts a XINS result to an HTTP response (implementation method).

Overrides:

convertResultImpl in class StandardCallingConvention

Parameters:

xinsResult - the XINS result object that should be converted to an HTTP response, will not be null.

httpResponse - the HTTP response object to configure, will not be null.

backpack - the request backpack, will not be null.

Throws:

IOException - if calling any of the methods in httpResponse causes an I/O error.

getAPI

protected final API getAPI()

Determines the current API.

Returns:

the current API, never null.

Since:

XINS 1.5.0

getSupportedMethods

protected String[] getSupportedMethods()

Determines which HTTP methods are supported for function invocations.

Each String in the returned array must be one supported method.

The returned array must not be null, it must only contain valid HTTP method names, so they may not contain whitespace, for example. Duplicates will be ignored. HTTP method names must be in uppercase.

There must be at least one HTTP method supported for function invocations.

Note that OPTIONS must not be returned by this method, as it is not an HTTP method that can ever be used to invoke a XINS function.

HTTP OPTIONS requests are treated differently. For the path * the capabilities of the whole server are returned. For other paths, the appropriate calling convention is determined, after which the set of supported HTTP methods is returned to the called.

Returns:

the HTTP methods supported, in a String array, must not be null.

Since:

XINS 1.5.0

getSupportedMethods

protected String[] getSupportedMethods(HttpServletRequest request)

Determines which HTTP methods are supported for function invocations, for the specified request.

Each String in the returned array must be one supported method.

The returned array may be null. If it is not, then the returned array must only contain valid HTTP method names, so they may not contain whitespace, for example. HTTP method names must be in uppercase.

There must be at least one HTTP method supported for function invocations.

Note that OPTIONS must not be returned by this method, as it is not an HTTP method that can ever be used to invoke a XINS function.

The set of supported methods must be a subset of the set returned by getSupportedMethods().

The default implementation of this method returns the set returned by getSupportedMethods().

Parameters:

request - the request to determine the supported methods for.

Returns:

the HTTP methods supported for the specified request, in a String array, can be null.

Since:

XINS 1.5.0

parseXMLRequest

protected Element parseXMLRequest(HttpServletRequest httpRequest)
                           throws IllegalArgumentException,
                                  InvalidRequestException

Parses XML from the specified HTTP request and checks that the content type is correct.

This method uses a cache to optimize performance if either of the parseXMLRequest methods is called multiple times for the same request.

Calling this method is equivalent with calling parseXMLRequest(HttpServletRequest,boolean) with the checkType argument set to true.

Parameters:

httpRequest - the HTTP request, cannot be null.

Returns:

the parsed element, never null.

Throws:

IllegalArgumentException - if httpRequest == null.

InvalidRequestException - if the HTTP request cannot be read or cannot be parsed correctly.

Since:

XINS 1.4.0

parseXMLRequest

protected Element parseXMLRequest(HttpServletRequest httpRequest,
                      boolean checkType)
                           throws IllegalArgumentException,
                                  InvalidRequestException

Parses XML from the specified HTTP request and optionally checks that the content type is correct.

Since XINS 1.4.0, this method uses a cache to optimize performance if either of the parseXMLRequest methods is called multiple times for the same request.

Parameters:

httpRequest - the HTTP request, cannot be null.

checkType - flag indicating whether this method should check that the content type of the request is text/xml.

Returns:

the parsed element, never null.

Throws:

IllegalArgumentException - if httpRequest == null.

InvalidRequestException - if the HTTP request cannot be read or cannot be parsed correctly.

Since:

XINS 1.3.0