org.pageseeder.bridge

Class PSConfig

java.lang.Object

org.pageseeder.bridge.PSConfig

public final class PSConfig
extends Object

Configuration of the PageSeeder server that the API should use to connect.

Since:

0.1.0

Version:

0.3.1

Author:

Christophe Lauret

Field Summary

Fields

Modifier and Type	Field and Description
protected static URI	DEFAULT_API The default URI for API access.
protected static String	DEFAULT_PREFIX The default PageSeeder site prefix.
protected static URI	DEFAULT_WEBSITE The default URI for user access.

Method Summary

Methods

Modifier and Type	Method and Description
StringBuilder	buildAPIURL()
StringBuilder	buildHostURL()
static void	configure(PSConfig p) Deprecated. Use setDefault(PSConfig) instead if no provider is available.
URL	getAPIBaseURL()
String	getAPIHost()
int	getAPIPort()
String	getAPIScheme()
static PSConfig	getDefault() Returns the default configuration.
URL	getDocumentBaseURL()
String	getHost()
String	getHostURL()
int	getPort()
String	getScheme()
String	getServletPrefix() Deprecated.
String	getSitePrefix()
URL	getWebsiteBaseURL()
static PSConfig	newInstance(Properties p) For use by service providers to create a new PSConfig instance.
static PSConfig	newInstance(String uri, String api) For use by service providers to create a new PSConfig instance.
static void	setDefault(PSConfig p) To configure the bridge manually.
static PSConfig	singleton() Deprecated. Use getDefault() instead.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_WEBSITE

protected static final URI DEFAULT_WEBSITE

The default URI for user access.

DEFAULT_API

protected static final URI DEFAULT_API

The default URI for API access.

DEFAULT_PREFIX

protected static final String DEFAULT_PREFIX

The default PageSeeder site prefix.

See Also:

Constant Field Values

Method Detail

getScheme

public String getScheme()

getHost

public String getHost()

getPort

public int getPort()

getAPIScheme

public String getAPIScheme()

getAPIHost

public String getAPIHost()

getAPIPort

public int getAPIPort()

getSitePrefix

public String getSitePrefix()

getServletPrefix

@Deprecated
public String getServletPrefix()

Deprecated.

getAPIBaseURL

public URL getAPIBaseURL()

Returns:

the base URL to use to connect.

getDocumentBaseURL

public URL getDocumentBaseURL()

Returns:

the default base URL for documents.

getWebsiteBaseURL

public URL getWebsiteBaseURL()

Returns:

the default base URL for the website.

buildAPIURL

public StringBuilder buildAPIURL()

Returns:

the API URL as a string builder.

buildHostURL

public StringBuilder buildHostURL()

Returns:

the host URL as a string builder.

getHostURL

public String getHostURL()

Returns:

the host URL.

setDefault

public static void setDefault(PSConfig p)

To configure the bridge manually.

Parameters:

p - The properties to use to configure the bridge manually.

getDefault

public static PSConfig getDefault()

Returns the default configuration.

This method will attempt to use the SPI for providing a configuration.

Returns:

the default configuration.

singleton

@Deprecated
public static PSConfig singleton()

Deprecated. Use getDefault() instead.

Returns:

the default config to use.

configure

@Deprecated
public static void configure(PSConfig p)

Deprecated. Use setDefault(PSConfig) instead if no provider is available.

To configure the bridge manually.

Parameters:

p - The properties to use to configure the bridge manually.

newInstance

public static PSConfig newInstance(Properties p)

For use by service providers to create a new PSConfig instance.

Parameters:

p - The set of properties to parse

Returns:

The corresponding configuration instance.

Throws:

IllegalArgumentException - If any or the properties yield to an malformed URL

newInstance

public static PSConfig newInstance(String uri,
                   String api)

For use by service providers to create a new PSConfig instance.

Parameters:

uri - The URL to use as the base URI for PageSeeder URIs

api - The URL to use as the base URI for API access

Returns:

The corresponding configuration instance.

Throws:

IllegalArgumentException - If any or the properties yield to an malformed URL