Package org.codice.ddf.configuration

Class SystemBaseUrl

java.lang.Object

org.codice.ddf.configuration.SystemBaseUrl

public final class SystemBaseUrl
extends Object

An immutable utility class for getting system url information. Information is pulled from the system properties.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_HOST
static final String	DEFAULT_HTTP_PORT
static final String	DEFAULT_HTTPS_PORT
static final String	DEFAULT_PROTOCOL
static final SystemBaseUrl	EXTERNAL
static final String	EXTERNAL_CONTEXT
static final String	EXTERNAL_HOST
static final String	EXTERNAL_HTTP_PORT
static final String	EXTERNAL_HTTPS_PORT
static final String	EXTERNAL_PORT
static final String	EXTERNAL_PROTOCOL
static final SystemBaseUrl	INTERNAL
static final String	INTERNAL_HOST
static final String	INTERNAL_HTTP_PORT
static final String	INTERNAL_HTTPS_PORT
static final String	INTERNAL_PORT
static final String	INTERNAL_PROTOCOL
static final String	INTERNAL_ROOT_CONTEXT

Method Summary

Modifier and Type	Method	Description
String	constructUrl(String context)	Construct a url for the given context
String	constructUrl(String context, boolean includeRootContext)	Construct a url for the given context
String	constructUrl(String proto, String context)	Construct a url based on the protocol and context
String	constructUrl(String proto, String context, boolean includeRootContext)	Construct a url based on the protocol and context
String	getBaseUrl()	Constructs and returns the base url for the system using the system default protocol
String	getBaseUrl(String proto)	Constructs and returns the base url for the system given a protocol
String	getHost()	Gets the current host name or IP address from the system properties, or DEFAULT_HOST if not set.
String	getHttpPort()
String	getHttpsPort()
String	getPort()	Gets the port number based on the the system protocol
String	getPort(String proto)	Gets the port number for the given protocol.
String	getProtocol()
String	getRootContext()

Methods inherited from class java.lang.Object

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

Field Details

INTERNAL_HTTP_PORT

public static final String INTERNAL_HTTP_PORT

See Also:

• Constant Field Values

INTERNAL_HTTPS_PORT

public static final String INTERNAL_HTTPS_PORT

See Also:

• Constant Field Values

INTERNAL_PORT

public static final String INTERNAL_PORT

See Also:

• Constant Field Values

INTERNAL_HOST

public static final String INTERNAL_HOST

See Also:

• Constant Field Values

INTERNAL_PROTOCOL

public static final String INTERNAL_PROTOCOL

See Also:

• Constant Field Values

INTERNAL_ROOT_CONTEXT

public static final String INTERNAL_ROOT_CONTEXT

See Also:

• Constant Field Values

EXTERNAL_HTTP_PORT

public static final String EXTERNAL_HTTP_PORT

See Also:

• Constant Field Values

EXTERNAL_HTTPS_PORT

public static final String EXTERNAL_HTTPS_PORT

See Also:

• Constant Field Values

EXTERNAL_PORT

public static final String EXTERNAL_PORT

See Also:

• Constant Field Values

EXTERNAL_HOST

public static final String EXTERNAL_HOST

See Also:

• Constant Field Values

EXTERNAL_PROTOCOL

public static final String EXTERNAL_PROTOCOL

See Also:

• Constant Field Values

EXTERNAL_CONTEXT

public static final String EXTERNAL_CONTEXT

See Also:

• Constant Field Values

DEFAULT_HTTP_PORT

public static final String DEFAULT_HTTP_PORT

See Also:

• Constant Field Values

DEFAULT_HTTPS_PORT

public static final String DEFAULT_HTTPS_PORT

See Also:

• Constant Field Values

DEFAULT_HOST

public static final String DEFAULT_HOST

See Also:

• Constant Field Values

DEFAULT_PROTOCOL

public static final String DEFAULT_PROTOCOL

See Also:

• Constant Field Values

EXTERNAL

public static final SystemBaseUrl EXTERNAL

INTERNAL

public static final SystemBaseUrl INTERNAL

Method Details

getPort

public String getPort()

Gets the port number based on the the system protocol

Returns:

getBaseUrl

public String getBaseUrl()

Constructs and returns the base url for the system using the system default protocol

Returns:

getBaseUrl

public String getBaseUrl(String proto)

Constructs and returns the base url for the system given a protocol

Parameters:

proto - Protocol to use during url construction. A null value will cause the system default protocol to be used

Returns:

constructUrl

public String constructUrl(String context)

Construct a url for the given context

Parameters:

context - The context path to be appened to the end of the base url

Returns:

constructUrl

public String constructUrl(String context,
 boolean includeRootContext)

Construct a url for the given context

Parameters:

context - The context path to be appened to the end of the base url

includeRootContext - Flag to indicated whether the rootcontext should be included in the url.

Returns:

constructUrl

public String constructUrl(String proto,
 String context)

Construct a url based on the protocol and context

Parameters:

proto - Protocol to use during url construction. A null value will cause the system default protocol to be used

context - The context path to be appened to the end of the base url

Returns:

constructUrl

public String constructUrl(String proto,
 String context,
 boolean includeRootContext)

Construct a url based on the protocol and context

Parameters:

proto - Protocol to use during url construction. A null value will cause the system default protocol to be used

context - The context path to be appened to the end of the base url

includeRootContext - Flag to indicated whether the rootcontext should be included in the url.

Returns:

getPort

public String getPort(String proto)

Gets the port number for the given protocol. If the protocol is null or not one of http or https returns the https port number.

Parameters:

proto - protocol (http or https)

Returns:

getHttpPort

public String getHttpPort()

getHttpsPort

public String getHttpsPort()

getHost

public String getHost()

Gets the current host name or IP address from the system properties, or DEFAULT_HOST if not set.

Returns:

host name, IP address or DEFAULT_HOST

getProtocol

public String getProtocol()

getRootContext

public String getRootContext()