Package com.helger.servlet

Class StaticServerInfo

java.lang.Object

com.helger.servlet.StaticServerInfo

@Immutable
public class StaticServerInfo
extends Object

This singleton instance represents default server information for locations where no request context is available (e.g. in scheduled tasks)

Author:

Philip Helger

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	StaticServerInfo(String sScheme, String sServerName, int nServerPort, String sContextPath)

Method Summary

Modifier and Type	Method	Description
String	getContextPath()
String	getFullContextPath()	This is a shortcut for getFullServerPath () + getContextPath ().
String	getFullServerPath()
static StaticServerInfo	getInstance()
String	getScheme()
String	getServerName()
int	getServerPort()
static StaticServerInfo	init(String sScheme, String sServerName, int nServerPort, String sContextPath)
static boolean	isSet()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

StaticServerInfo

protected StaticServerInfo(@Nonnull @Nonempty
                           String sScheme,
                           @Nonnull @Nonempty
                           String sServerName,
                           @Nonnegative
                           int nServerPort,
                           @Nonnull
                           String sContextPath)

Method Detail

getScheme

@Nonnull
public String getScheme()

Returns:

The scheme. E.g. "http" or "https".

getServerName

@Nonnull
public String getServerName()

Returns:

The server name without scheme. E.g. "www.helger.com"

getServerPort

@CheckForSigned
public int getServerPort()

Returns:

The server port we're running on. May be -1, if constructed from a URL and the passed scheme is neither "http" nor "https".

getContextPath

@Nonnull
public String getContextPath()

Returns:

"/context" or "" (empty string)

getFullServerPath

@Nonnull
public String getFullServerPath()

Returns:

scheme://server:port or scheme://server if the default port was used

getFullContextPath

@Nonnull
public String getFullContextPath()

This is a shortcut for getFullServerPath () + getContextPath ().

Returns:

scheme://server:port/context or scheme://server:port for the ROOT context.

toString

public String toString()

Overrides:

toString in class Object

isSet

public static boolean isSet()

init

@Nonnull
public static StaticServerInfo init(@Nonnull @Nonempty
                                    String sScheme,
                                    @Nonnull @Nonempty
                                    String sServerName,
                                    @Nonnegative
                                    int nServerPort,
                                    @Nonnull
                                    String sContextPath)

getInstance

@Nonnull
public static StaticServerInfo getInstance()