org.exoplatform.services.wsrp2.consumer
Interface URLTemplateComposer

All Known Implementing Classes:

URLTemplateComposerImpl

public interface URLTemplateComposer

This interface provides methods to generate URL templates.

The generated templates will be transmitted to Producers (or respectively portlets) that are willing to properly write URLs for a Consumer. (With templates the Consumer indicates how it needs URLs formatted in order to process them properly.)

Author:

Stefan Behl, Benjamin Mestrallet

Method Summary

String	createBlockingActionTemplate(String path) Creates a blocking action template.
String	createDefaultTemplate(String path) Creates a default template.
String	createRenderTemplate(String path) Creates a render template.
String	createResourceTemplate(String path) Creates a resource template.
String	createSecureBlockingActionTemplate(String path) Creates a secure blocking action template.
String	createSecureDefaultTemplate(String path) Creates a secure default template.
String	createSecureRenderTemplate(String path) Creates a secure render template.
String	createSecureResourceTemplate(String path) Creates a secure resource template.
String	getNamespacePrefix() Get the consumers namespace prefix which is used by the portlet to namespace tokens which need to be unique on a aggregated page.
void	setHost(String host)
void	setPort(int port)

Method Detail

setHost

void setHost(String host)

setPort

void setPort(int port)

createBlockingActionTemplate

String createBlockingActionTemplate(String path)

Creates a blocking action template. Includes tokens for url-type, portletMode, navigationalState, interactionState and windowState to be replaced by the producer.

Parameters:

path -

Returns:

String representing the entire template.

createSecureBlockingActionTemplate

String createSecureBlockingActionTemplate(String path)

Creates a secure blocking action template. Includes tokens for url-type, portletMode, navigationalState, interactionState, windowState and secureURL to be replaced by the producer.

Returns:

String representing the entire template.

createRenderTemplate

String createRenderTemplate(String path)

Creates a render template. Includes tokens for url-type, portletMode, navigationalState, interactionState and windowState to be replaced by the producer.

Returns:

String representing the entire template.

createSecureRenderTemplate

String createSecureRenderTemplate(String path)

Creates a secure render template. Includes tokens for url-type, portletMode, navigationalState, interactionState, windowState and secureURL to be replaced by the producer.

Returns:

String representing the entire template.

createResourceTemplate

String createResourceTemplate(String path)

Creates a resource template. Includes tokens for url-type, rewriteResource and url to be replaced by the producer.

Returns:

String representing the entire template.

createSecureResourceTemplate

String createSecureResourceTemplate(String path)

Creates a secure resource template. Includes tokens for url-type, url, rewriteResource, and secureURL to be replaced by the producer.

Returns:

String representing the entire template.

createDefaultTemplate

String createDefaultTemplate(String path)

Creates a default template. Includes tokens for url-type, portletMode, navigationalState, interactionState, windowState, url, rewriteResource and secureURL to be replaced by the producer.

Returns:

String representing the entire template.

createSecureDefaultTemplate

String createSecureDefaultTemplate(String path)

Creates a secure default template. Includes tokens for url-type, portletMode, navigationalState, interactionState, windowState, url, rewriteResource and secureURL to be replaced by the producer.

Returns:

String representing the entire template.

getNamespacePrefix

String getNamespacePrefix()

Get the consumers namespace prefix which is used by the portlet to namespace tokens which need to be unique on a aggregated page.

Returns:

The namespace prefix of the consumer.