net.officefloor.plugin.web.http.location

Class HttpApplicationLocationMangedObject

java.lang.Object

net.officefloor.plugin.web.http.location.HttpApplicationLocationMangedObject

All Implemented Interfaces:

CoordinatingManagedObject<HttpApplicationLocationManagedObjectSource.Dependencies>, ManagedObject, HttpApplicationLocation

public class HttpApplicationLocationMangedObject
extends Object
implements CoordinatingManagedObject<HttpApplicationLocationManagedObjectSource.Dependencies>, HttpApplicationLocation

HttpApplicationLocation ManagedObject.

Author:

Daniel Sagenschneider

Constructor Summary

Constructors

Constructor and Description
HttpApplicationLocationMangedObject(String domain, int httpPort, int httpsPort, String contextPath, String clusterHostName, int clusterHttpPort, int clusterHttpsPort) Initiate.

Method Summary

Modifier and Type	Method and Description
String	getClusterHostName() Obtains the name of the host for the application within the cluster.
int	getClusterHttpPort() The cluster may be behind a load balancer and the application may be running on a different port than expected by the client.
int	getClusterHttpsPort() The cluster may be behind a load balancer and the application may be running on a different port than expected by the client.
String	getContextPath() Obtains the URI prefix to the application.
String	getDomain() Obtains the domain for the application.
int	getHttpPort() Obtains the HTTP port.
int	getHttpsPort() Obtains the HTTPS port.
Object	getObject() Obtains the object being managed.
void	loadObjects(ObjectRegistry<HttpApplicationLocationManagedObjectSource.Dependencies> registry) Loads the Objects of the ManagedObject instances to be referenced by this CoordinatingManagedObject.
String	transformToApplicationCanonicalPath(String requestUri) Transforms the HttpRequest request URI to a canonical path relative to the application root.
static String	transformToCanonicalPath(String path) Transforms the input Request URI path to a canonical path.
String	transformToClientPath(String applicationPath, boolean isSecure) Transforms the application path to a client path.

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpApplicationLocationMangedObject

public HttpApplicationLocationMangedObject(String domain,
                                           int httpPort,
                                           int httpsPort,
                                           String contextPath,
                                           String clusterHostName,
                                           int clusterHttpPort,
                                           int clusterHttpsPort)

Initiate.

Parameters:

domain - Domain.

httpPort - HTTP port.

httpsPort - HTTPS port.

contextPath - Context path.

clusterHostName - Cluster host name.

clusterHttpPort - Cluster HTTP port.

clusterHttpsPort - Cluster HTTPS port.

Method Detail

transformToCanonicalPath

public static String transformToCanonicalPath(String path)
                                       throws InvalidHttpRequestUriException

Transforms the input Request URI path to a canonical path.

Parameters:

path - Path to transform.

Returns:

Canonical path.

Throws:

InvalidHttpRequestUriException - Should the Request URI path be invalid.

loadObjects

public void loadObjects(ObjectRegistry<HttpApplicationLocationManagedObjectSource.Dependencies> registry)
                 throws Throwable

Description copied from interface: CoordinatingManagedObject

Loads the Objects of the ManagedObject instances to be referenced by this CoordinatingManagedObject.

References to the loaded Objects must be released on recycling the ManagedObject.

Specified by:

loadObjects in interface CoordinatingManagedObject<HttpApplicationLocationManagedObjectSource.Dependencies>

Parameters:

registry - Registry of the Objects for the ManagedObject instances.

Throws:

Throwable - Should this CoordinatingManagedObject fail to load the ManagedObject.

getObject

public Object getObject()
                 throws Throwable

Description copied from interface: ManagedObject

Obtains the object being managed.

Specified by:

getObject in interface ManagedObject

Returns:

Object being managed.

Throws:

Throwable - Indicating failed to obtain the object for use.

getDomain

public String getDomain()

Description copied from interface: HttpApplicationLocation

Obtains the domain for the application.

This is as the client will see the application.

Specified by:

getDomain in interface HttpApplicationLocation

Returns:

Domain for the application.

getHttpPort

public int getHttpPort()

Description copied from interface: HttpApplicationLocation

Obtains the HTTP port.

This is as the client will see the application.

Specified by:

getHttpPort in interface HttpApplicationLocation

Returns:

HTTP port.

getHttpsPort

public int getHttpsPort()

Description copied from interface: HttpApplicationLocation

Obtains the HTTPS port.

This is as the client will see the application.

Specified by:

getHttpsPort in interface HttpApplicationLocation

Returns:

HTTPS port.

getContextPath

public String getContextPath()

Description copied from interface: HttpApplicationLocation

Obtains the URI prefix to the application.

Specified by:

getContextPath in interface HttpApplicationLocation

Returns:

URI prefix to the application. May be null if no context path for the application.

getClusterHostName

public String getClusterHostName()

Description copied from interface: HttpApplicationLocation

Obtains the name of the host for the application within the cluster. This name should be understood by all nodes within the cluster.

Specified by:

getClusterHostName in interface HttpApplicationLocation

Returns:

Name of the host within the cluster.

getClusterHttpPort

public int getClusterHttpPort()

Description copied from interface: HttpApplicationLocation

The cluster may be behind a load balancer and the application may be running on a different port than expected by the client.

Specified by:

getClusterHttpPort in interface HttpApplicationLocation

Returns:

Actual port on the cluster host the application is running on.

getClusterHttpsPort

public int getClusterHttpsPort()

Description copied from interface: HttpApplicationLocation

The cluster may be behind a load balancer and the application may be running on a different port than expected by the client.

Specified by:

getClusterHttpsPort in interface HttpApplicationLocation

Returns:

Actual secure port on the cluster host the application is running on.

transformToApplicationCanonicalPath

public String transformToApplicationCanonicalPath(String requestUri)
                                           throws InvalidHttpRequestUriException,
                                                  IncorrectHttpRequestContextPathException

Description copied from interface: HttpApplicationLocation

Transforms the HttpRequest request URI to a canonical path relative to the application root. This will strip off the domain, port and context path.

Specified by:

transformToApplicationCanonicalPath in interface HttpApplicationLocation

Parameters:

requestUri - Request URI from the HttpRequest.

Returns:

Canonical path relative to the application root.

Throws:

InvalidHttpRequestUriException - Should the HttpRequest request URI be invalid.

IncorrectHttpRequestContextPathException - Should the HttpRequest request URI have the incorrect context path for the application.

transformToClientPath

public String transformToClientPath(String applicationPath,
                                    boolean isSecure)

Description copied from interface: HttpApplicationLocation

Transforms the application path to a client path. It will prepend the path with the application context path and if necessary provides HTTP/HTTPS protocol and domain.

Specified by:

transformToClientPath in interface HttpApplicationLocation

Parameters:

applicationPath - Path relative to the application root.

isSecure - Indicates if the resulting client path is to be secure. In other words to use the HTTPS protocol.

Returns:

Client path.