org.pageseeder.bridge.model

Class PSAddressable

java.lang.Object

org.pageseeder.bridge.model.PSAddressable

All Implemented Interfaces:

Serializable, PSEntity

Direct Known Subclasses:

PSGroupFolder, PSURI

public abstract class PSAddressable
extends Object
implements PSEntity

Version:

0.1.0

Author:

Christophe Lauret

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_HOST The default host.
static int	DEFAULT_PORT The default port.
static String	DEFAULT_SCHEME The default scheme to use.
static int	MAX_PORT_NUMBER The maximum valid port number.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PSAddressable(String url) Instantiate a new addressable object from the specified url.
	PSAddressable(String scheme, String host, int port, String path) Instantiate a new addressable object from the specified scheme, host, port and path.

Method Summary

Methods

Modifier and Type	Method and Description
String	getHost()
String	getHostURL()
String	getPath()
int	getPort()
String	getScheme()
String	getURL()
void	setHost(String host)
void	setPath(String path)
void	setPort(int port)
void	setScheme(String scheme)
String	toURL()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.pageseeder.bridge.PSEntity

checkValid, getId, getIdentifier, getKey, isIdentifiable, isValid

Field Detail

MAX_PORT_NUMBER

public static final int MAX_PORT_NUMBER

The maximum valid port number.

See Also:

Constant Field Values

DEFAULT_SCHEME

public static final String DEFAULT_SCHEME

The default scheme to use.

See Also:

Constant Field Values

DEFAULT_HOST

public static final String DEFAULT_HOST

The default host.

See Also:

Constant Field Values

DEFAULT_PORT

public static final int DEFAULT_PORT

The default port.

See Also:

Constant Field Values

Constructor Detail

PSAddressable

protected PSAddressable(String url)

Instantiate a new addressable object from the specified url.

The URL may omit the scheme or authority part, it which case it will default on the default values from the configuration.

Parameters:

url - The url.

Throws:

IllegalArgumentException - If the specified URL is invalid

PSAddressable

public PSAddressable(String scheme,
             String host,
             int port,
             String path)

Instantiate a new addressable object from the specified scheme, host, port and path.

Parameters:

scheme - The scheme "http" or "https"

host - Where the resource is hosted.

port - The port (or negative to use the default port).

path - The path to the resource.

Method Detail

getScheme

public final String getScheme()

Returns:

the protocol scheme "http" or "https"

getHost

public final String getHost()

Returns:

the host

getPort

public final int getPort()

Returns:

the port

getPath

public final String getPath()

Returns:

the path

getHostURL

public final String getHostURL()

Returns:

the path

getURL

public final String getURL()

Returns:

the path

setScheme

public final void setScheme(String scheme)

Parameters:

scheme - the scheme to set

setHost

public final void setHost(String host)

Parameters:

host - the host to set

setPort

public final void setPort(int port)

Parameters:

port - the port to set

Throws:

IllegalArgumentException - If the port number is too large

setPath

public final void setPath(String path)

Parameters:

path - the path to set

toURL

public final String toURL()

Returns:

Recomputes the URL from the attributes in this class.