net.officefloor.plugin.web.http.location

Interface HttpApplicationLocation

All Known Implementing Classes:

HttpApplicationLocationMangedObject

public interface HttpApplicationLocation

Location details of the HTTP application.

Author:

Daniel Sagenschneider

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.
String	transformToApplicationCanonicalPath(String requestUri) Transforms the HttpRequest request URI to a canonical path relative to the application root.
String	transformToClientPath(String applicationPath, boolean isSecure) Transforms the application path to a client path.

Method Detail

getDomain

String getDomain()

Obtains the domain for the application.

This is as the client will see the application.

Returns:

Domain for the application.

getHttpPort

int getHttpPort()

Obtains the HTTP port.

This is as the client will see the application.

Returns:

HTTP port.

getHttpsPort

int getHttpsPort()

Obtains the HTTPS port.

This is as the client will see the application.

Returns:

HTTPS port.

getContextPath

String getContextPath()

Obtains the URI prefix to the application.

Returns:

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

getClusterHostName

String getClusterHostName()

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

Returns:

Name of the host within the cluster.

getClusterHttpPort

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.

Returns:

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

getClusterHttpsPort

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.

Returns:

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

transformToApplicationCanonicalPath

String transformToApplicationCanonicalPath(String requestUri)
                                    throws InvalidHttpRequestUriException,
                                           IncorrectHttpRequestContextPathException

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

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

String transformToClientPath(String applicationPath,
                             boolean isSecure)

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.

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.