org.alfresco.wcm.client

Class WebSiteService

java.lang.Object

org.alfresco.wcm.client.WebSiteService

Direct Known Subclasses:

WebSiteServiceImpl

public abstract class WebSiteService
extends Object

Web Site Service Interface

Author:

Roy Wetherall, Brian Remmington

Constructor Summary

Constructors

Constructor and Description
WebSiteService()

Method Summary

Methods

Modifier and Type	Method and Description
static WebSite	getThreadWebSite() Retrieve the WebSite object that has most recently been set on the current thread via a call to setThreadWebSite(WebSite).
abstract WebSite	getWebSite(String hostName, int hostPort) Gets the web site that relates to the host name and port.
abstract WebSite	getWebSite(String hostName, int hostPort, String contextPath) Gets the website that relates to the specified host, port, and context path.
abstract Collection<WebSite>	getWebSites() Gets all the web sites hosted on the repository
static void	setThreadWebSite(WebSite website) Set the supplied website in a thread-local container to make it available for all activity that subsequently takes place on the current thread

Methods inherited from class java.lang.Object

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

Constructor Detail

WebSiteService

public WebSiteService()

Method Detail

getWebSites

public abstract Collection<WebSite> getWebSites()

Gets all the web sites hosted on the repository

Returns:

Collection web sites

getWebSite

public abstract WebSite getWebSite(String hostName,
                 int hostPort)

Gets the web site that relates to the host name and port. Assumes the root context.

Parameters:

hostName - host name

hostPort - port number

Returns:

WebSite web site, null if non found

getWebSite

public abstract WebSite getWebSite(String hostName,
                 int hostPort,
                 String contextPath)

Gets the website that relates to the specified host, port, and context path. For example, if your webapp is deployed at "http://my.web.site/wqs" then the host would be "my.web.site", the port would be 80 (the default HTTP port) and the context path would be "wqs".

Parameters:

hostName -

hostPort -

contextPath -

Returns:

The matching website or null if none found

setThreadWebSite

public static void setThreadWebSite(WebSite website)

Set the supplied website in a thread-local container to make it available for all activity that subsequently takes place on the current thread

Parameters:

website -

getThreadWebSite

public static WebSite getThreadWebSite()

Retrieve the WebSite object that has most recently been set on the current thread via a call to setThreadWebSite(WebSite).

Returns:

The WebSite object most recently set on this thread or null if no object has been set.