Skip navigation links

oracle.webservices.provider
Interface ProviderConfig

public interface ProviderConfig

Configuration related information for the Provider. This information provides access to Provider instance details. This may include access to information from deployment descriptors, and may entail communication with the container.

Field Summary

static String	PROPAGATE_DYNAMIC_ENDPOINTS The property key for requesting propagation of dynamic endpoints (endpoints created as a results of a ProviderConfig.addService() invocation) to the other nodes in the configuratioon group.
static String	VALIDATE_SOAP_SCHEMA The property key for requesting validation of incoming soap requests.

Method Summary

void	addService(String pathInfo, Definition definition, QName wsdlPort, QName serviceName, Object policy) Add a service from inside the provider implementation.
void	addService(String pathInfo, InputStream wsdlStream, String wsdlBaseURI, QName wsdlPort, QName serviceName, Object policy) Add a service from inside the provider implementation.
void	addService(String pathInfo, URL wsdlURL, QName wsdlPort, QName serviceName, Object policy) Add a service from inside the provider implementation.
boolean	containsProperty(String name) Check whether a particular property was provided.
Object	getContainerContext() Return the Context of the provider container.
String	getProperty(String name) Get the property value corresponding to the property name.
Iterator	getPropertyNames() Return the list of properties defined for this configuration.
Iterator	getProviderEndpointPaths() Get the collection of dynamically added provider endpoint paths.
ProviderInterceptorPipeline	getProviderInterceptorPipeline(String pathInfo) Get the ProviderInterceptorPipeline configured for the specified provider endpoint.
String	getProviderName() Return the provider name.
Definition	getWSDL(String pathInfo) Returns the WSDL Definition for the given endpoint.
String	getWSDLLocation() Return the WSDL location.
QName	getWSDLPort() Return the WSDL Port QName.
QName	getWSDLPort(String pathInfo) Return the WSDL Port QName for the specified pathInfo.
QName	getWSDLService() Return the WSDL Service QName.
QName	getWSDLService(String pathInfo) Return the WSDL Service QName for the specified pathInfo.
URL	getWSDLURL(String pathInfo) Get the URL for the WSDL definition associated with the specified provider endpoint path.
void	removeProperty(String name) Remove the specified property.
void	removeService(String pathInfo) Remove a service associated with a given pathInfo.
void	setProperty(String name, String value) Set a property.

Field Detail

VALIDATE_SOAP_SCHEMA

static final String VALIDATE_SOAP_SCHEMA

The property key for requesting validation of incoming soap requests. If this property value is set to "true", then the container will validate the incoming SOAP requests against the WSDL definition's types schema.

See Also:

Constant Field Values

PROPAGATE_DYNAMIC_ENDPOINTS

static final String PROPAGATE_DYNAMIC_ENDPOINTS

The property key for requesting propagation of dynamic endpoints (endpoints created as a results of a ProviderConfig.addService() invocation) to the other nodes in the configuratioon group. If this property value is set to "true", then the endpoint created in the target instance will be propagated to the other members of the same configuration group.

See Also:

Constant Field Values

Method Detail

addService

void addService(String pathInfo,
                URL wsdlURL,
                QName wsdlPort,
                QName serviceName,
                Object policy)
                throws ProviderException

Add a service from inside the provider implementation.

Parameters:

pathInfo - Extra path information associated with the URL the client sent when it made this request. The extra path information follows the servlet path but precedes the query string and will start with a "/" character. Should not be null.

wsdlURL - The URL of WSDL. Can be 'file://' or 'http://'. Should not be null.

wsdlPort - QName of the WSDL port. Can be null.

serviceName - QName of the WSDL service. Can be null.

policy - Policy file. Can be null.

Throws:

ProviderException

addService

void addService(String pathInfo,
                Definition definition,
                QName wsdlPort,
                QName serviceName,
                Object policy)
                throws ProviderException

Add a service from inside the provider implementation.

Parameters:

pathInfo - Extra path information associated with the URL the client sent when it made this request. The extra path information follows the servlet path but precedes the query string and will start with a "/" character. Should not be null.

definition - The wsdl Definition (JSR 110) for the service.

wsdlPort - QName of the WSDL port. Can be null.

serviceName - QName of the WSDL service. Can be null.

policy - Policy file. Can be null.

Throws:

ProviderException

addService

void addService(String pathInfo,
                InputStream wsdlStream,
                String wsdlBaseURI,
                QName wsdlPort,
                QName serviceName,
                Object policy)
                throws ProviderException

Add a service from inside the provider implementation.

Parameters:

pathInfo - Extra path information associated with the URL the client sent when it made this request. The extra path information follows the servlet path but precedes the query string and will start with a "/" character. Should not be null.

wsdlStream - The WSDL input stream.

wsdlBaseURI - The base URI for the WSDL.

wsdlPort - QName of the WSDL port. Can be null.

serviceName - QName of the WSDL service. Can be null.

policy - Policy file. Can be null.

Throws:

ProviderException

removeService

void removeService(String pathInfo)

Remove a service associated with a given pathInfo.

Parameters:

pathInfo - The pathInfo of the service to remove.

getContainerContext

Object getContainerContext()

Return the Context of the provider container.

Returns:

Object. Returns the ServletContext if the provider is hosted by a servlet container

getProviderName

String getProviderName()

Return the provider name.

Returns:

String. Returns the provider name.

getWSDLLocation

String getWSDLLocation()

Return the WSDL location.

Returns:

String. Returns the location of WSDL file if provided in the deployment configuration file. If not, null is returned.

getWSDLPort

QName getWSDLPort()

Return the WSDL Port QName.

Returns:

QName. Returns the Port QName of WSDL file if provided in the deployment configuration file. If not, null is returned.

getWSDLPort

QName getWSDLPort(String pathInfo)

Return the WSDL Port QName for the specified pathInfo.

Returns:

Returns the Port QName of WSDL file if provided in the deployment configuration file or dynamically added by the Provider implementation. If not, null.

getWSDLService

QName getWSDLService()

Return the WSDL Service QName.

Returns:

QName. Returns the Service QName of WSDL file if provided in the deployment configuration file. If not, null is returned.

getWSDLService

QName getWSDLService(String pathInfo)

Return the WSDL Service QName for the specified pathInfo.

Returns:

Returns the Service QName of WSDL file if provided in the deployment configuration file or dynamically added by the Provider implementation. If not, null.

containsProperty

boolean containsProperty(String name)

Check whether a particular property was provided. Properties can be supplied through a configuration file, oracle-webservices.xml, or dynamically set by the provider implementation (e.g. in the init() method).

Parameters:

name - Name of the property of interest.

Returns:

true if the specified property exists.

getProperty

String getProperty(String name)

Get the property value corresponding to the property name.

Parameters:

name - Name of the property of interest.

Returns:

The value of the property if it exists; Otherwise, null.

getPropertyNames

Iterator getPropertyNames()

Return the list of properties defined for this configuration.

Returns:

An Iterator for the list of property names.

removeProperty

void removeProperty(String name)

Remove the specified property.

Parameters:

name - The name of property to be removed.

setProperty

void setProperty(String name,
                 String value)

Set a property. Used to communicate with the container.

Parameters:

name - The name of a property

value - The associated property value

getWSDLURL

URL getWSDLURL(String pathInfo)

Get the URL for the WSDL definition associated with the specified provider endpoint path.

Parameters:

pathInfo - The path associated with a dynamically added provider endpoint (see Provider.addService). Specify null to get the URL for the WSDL definition associated with this provider by its deployment descriptor (oracle-webservices.xml) entry.

Returns:

The WSDL URL for the provider endpoint, or null if no WSDL is associated with the specified path.

getProviderInterceptorPipeline

ProviderInterceptorPipeline getProviderInterceptorPipeline(String pathInfo)

Get the ProviderInterceptorPipeline configured for the specified provider endpoint.

Parameters:

pathInfo - The pathInfo for the endpoint of interest.

getProviderEndpointPaths

Iterator getProviderEndpointPaths()

Get the collection of dynamically added provider endpoint paths.

Returns:

An Iterator for the collection of paths.

getWSDL

Definition getWSDL(String pathInfo)

Returns the WSDL Definition for the given endpoint.

Parameters:

pathInfo - the pathInfo for a dynanmic endpoint or null for the static endpoint.

Returns:

the WSDL definition.

Skip navigation links