org.n52.wps.server

Class CapabilitiesConfiguration

java.lang.Object

org.n52.wps.server.CapabilitiesConfiguration

public class CapabilitiesConfiguration
extends Object

Encapsulation of the WPS Capabilities document. This class has to be initialized with either a file, URL, path or instance.

Author:

foerster, Christian Autermann

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_URL

Method Summary

Modifier and Type	Method and Description
static net.opengis.wps.x100.CapabilitiesDocument	getInstance() Get the WPS Capabilities for this service.
static net.opengis.wps.x100.CapabilitiesDocument	getInstance(boolean reload) Get the WPS Capabilities for this service and optionally force a reload.
static net.opengis.wps.x100.CapabilitiesDocument	getInstance(net.opengis.wps.x100.CapabilitiesDocument skel) Gets the WPS Capabilities using the specified skeleton.
static net.opengis.wps.x100.CapabilitiesDocument	getInstance(File file) Gets the WPS Capabilities using the specified file to obtain the skeleton.
static net.opengis.wps.x100.CapabilitiesDocument	getInstance(String filePath) Gets the WPS Capabilities using the specified file to obtain the skeleton.
static net.opengis.wps.x100.CapabilitiesDocument	getInstance(URL url) Gets the WPS Capabilities using the specified URL to obtain the skeleton.
static boolean	ready() Checks if the capabilities document is loaded.
static void	reloadSkeleton() Force a reload of the capabilities skeleton.

Methods inherited from class java.lang.Object

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

Field Detail

ENDPOINT_URL

public static String ENDPOINT_URL

Method Detail

getInstance

public static net.opengis.wps.x100.CapabilitiesDocument getInstance(String filePath)
                                                             throws org.apache.xmlbeans.XmlException,
                                                                    IOException

Gets the WPS Capabilities using the specified file to obtain the skeleton. All future calls to getInstance() and getInstance(boolean) will use this file to obtain the skeleton.

Parameters:

filePath - the File pointing to a skeleton

Returns:

the capabilities document

Throws:

org.apache.xmlbeans.XmlException - if the Capabilities skeleton is not valid

IOException - if an IO error occurs

getInstance

public static net.opengis.wps.x100.CapabilitiesDocument getInstance(File file)
                                                             throws org.apache.xmlbeans.XmlException,
                                                                    IOException

Gets the WPS Capabilities using the specified file to obtain the skeleton. All future calls to getInstance() and getInstance(boolean) will use this file to obtain the skeleton.

Parameters:

file - the File pointing to a skeleton

Returns:

the capabilities document

Throws:

org.apache.xmlbeans.XmlException - if the Capabilities skeleton is not valid

IOException - if an IO error occurs

getInstance

public static net.opengis.wps.x100.CapabilitiesDocument getInstance(URL url)
                                                             throws org.apache.xmlbeans.XmlException,
                                                                    IOException

Gets the WPS Capabilities using the specified URL to obtain the skeleton. All future calls to getInstance() and getInstance(boolean) will use this URL to obtain the skeleton.

Parameters:

url - the URL pointing to a skeleton

Returns:

the capabilities document

Throws:

org.apache.xmlbeans.XmlException - if the Capabilities skeleton is not valid

IOException - if an IO error occurs

getInstance

public static net.opengis.wps.x100.CapabilitiesDocument getInstance(net.opengis.wps.x100.CapabilitiesDocument skel)
                                                             throws org.apache.xmlbeans.XmlException,
                                                                    IOException

Gets the WPS Capabilities using the specified skeleton. All future calls to getInstance() and getInstance(boolean) will use this skeleton.

Parameters:

skel - the skeleton

Returns:

the capabilities document

Throws:

org.apache.xmlbeans.XmlException - if the Capabilities skeleton is not valid

IOException - if an IO error occurs

getInstance

public static net.opengis.wps.x100.CapabilitiesDocument getInstance()
                                                             throws org.apache.xmlbeans.XmlException,
                                                                    IOException

Get the WPS Capabilities for this service. The capabilities are reloaded if caching is not enabled in the WPS configuration.

Returns:

the capabilities document

Throws:

org.apache.xmlbeans.XmlException - if the Capabilities skeleton is not valid

IOException - if an IO error occurs

getInstance

public static net.opengis.wps.x100.CapabilitiesDocument getInstance(boolean reload)
                                                             throws org.apache.xmlbeans.XmlException,
                                                                    IOException

Get the WPS Capabilities for this service and optionally force a reload.

Parameters:

reload - if the capabilities should be reloaded

Returns:

the capabilities document

Throws:

org.apache.xmlbeans.XmlException - if the Capabilities skeleton is not valid

IOException - if an IO error occurs

reloadSkeleton

public static void reloadSkeleton()
                           throws org.apache.xmlbeans.XmlException,
                                  IOException

Force a reload of the capabilities skeleton.

Throws:

org.apache.xmlbeans.XmlException - if the Capabilities skeleton is not valid

IOException - if an IO error occurs

ready

public static boolean ready()

Checks if the capabilities document is loaded.

Returns:

if the capabilities are ready.