Skip navigation links

Java API Reference for Oracle Infrastructure Web Services
11
Release 1 (11.1.1)

E10654-02


oracle.webservices
Interface WebServiceEndpointInfo

All Superinterfaces:
oracle.fabric.common.OperationNameExtractor

public interface WebServiceEndpointInfo
extends oracle.fabric.common.OperationNameExtractor

Implementations of this interface provide access to information about a web service endpoint.


Method Summary
 void addOperation(QName name)
          Add a web service operation.
 QName getBindingName()
          Get the QName of the binding.
 Element getDescriptorElement()
          Get the port-component descriptor Element associated with this endpoint.
 String getEndpointAddressSubContextUri()
          Get the part of the endpoint address that follows the root context.
 String getEndpointIdentifier()
          Gets the unique endpoint identifier
 String getEndpointName()
          Get the name of the web service endpoint.
 Map<String,String> getEnvelopeLimits()
          Get the configuration setting request-envelope-limit for this endpoint.
 String getImplementorType()
          Determine the name of the web service implementor type.
 Level getLoggingLevel()
          Determine the configured logging level for this endpoint.
 long getMaxRequestSize()
          Determine the size of the largest request recorded thus far.
 Integer getMtomThreshold()
          get the MTOM threshold configured
 Collection getOperations()
          Get all the web service operations.
 QName getPortName()
          Get the name of the web service port as it is defined in the WSDL definition.
 WebServiceEndpointRuntimeData getRuntimeData()
          Get the runtime data associated with this endpoint.
 QName getServiceName()
          Get the QName of the web service.
 Map<String,String> getSoapXml()
          Get the configuration setting soap-xml for this endpoint.
 oracle.j2ee.ws.saaj.util.mime.StreamingAttachmentsConfig getStreamingAttachmentsConfig()
          Get the configuration object for SAAJ streaming.
 String getStyle()
          Get the style of the endpoint.
 String getVersionID()
          Get the versionID of the endpoint.
 String getWebServiceName()
          Get the name of the web service this endpoint provides.
 URL getWSDL()
          Get the WSDL URL for this endpoint.
 InputStream getWsdlAsStream()
          Get an InputStream for reading the WSDL definition with which this endpoint is associated.
 Definition getWSDLDefinition()
          Get the WSDL Definition that describes this endpoint.
 File getWsdlFileAsFile()
          Get the WSDL Definition document as a File instance.
 boolean hasPolicyReference()
          Test if this port has a reference to an external policy
 boolean implementedByEjbComponent()
          Determine whether or not this endpoint is implemented by an EJB.
 boolean isEnabled()
          Check if this port is enabled.
 boolean isMexEnabled()
          Check if metadata exchange is allowed.
 boolean isMtomEncodeFault()
          Check if SOAP fault messages should be MTOM-encoded when MTOM policy is enabled.
 boolean isMtomSupported()
          Determine whether or not MTOM is supported by this endpoint.
 boolean isRestSupported()
          Determine whether or not REST is supported by this endpoint.
 boolean isSchemaValidateInput()
          Check if schema validation is set for this port.
 boolean isSoapSupported()
          Determine whether or not SOAP processing is supported by this endpoint.
 void setLoggingLevel(Level level)
          Set the logging level for this endpoint.
 void setRuntimeData(WebServiceEndpointRuntimeData runtimeData)
          Associate the specified runtime data with this endpoint.

 

Methods inherited from interface oracle.fabric.common.OperationNameExtractor
getOperationNameFromInputMessage, getOperationNameFromOutputMessage

 

Method Detail

getWSDLDefinition

Definition getWSDLDefinition()
Get the WSDL Definition that describes this endpoint.
Returns:
A javax.wsdl.Definition instance.

getPortName

QName getPortName()
Get the name of the web service port as it is defined in the WSDL definition.
Returns:
The port QName.

getBindingName

QName getBindingName()
Get the QName of the binding.
Returns:
The binding QName.

getServiceName

QName getServiceName()
Get the QName of the web service.
Returns:
The web service QName.

getWebServiceName

String getWebServiceName()
Get the name of the web service this endpoint provides.
Returns:
The name of the web service.

getEndpointName

String getEndpointName()
Get the name of the web service endpoint.
Returns:
The web service endpoint name.

getOperations

Collection getOperations()
Get all the web service operations.
Returns:
A Collection of WebServiceOperationInfo instances.

addOperation

void addOperation(QName name)
Add a web service operation.
Parameters:
name - The unique QName of the operation to add.

implementedByEjbComponent

boolean implementedByEjbComponent()
Determine whether or not this endpoint is implemented by an EJB.
Returns:
true, if the endpoint is implemented by an EJB; Otherwise, false.

getDescriptorElement

Element getDescriptorElement()
Get the port-component descriptor Element associated with this endpoint.
Returns:
The DOM Element that describes this web service endpoint.

getWSDL

URL getWSDL()
            throws MalformedURLException
Get the WSDL URL for this endpoint.
Returns:
A java.net.URL instance describing the WSDL location.
Throws:
MalformedURLException

getWsdlFileAsFile

File getWsdlFileAsFile()
Get the WSDL Definition document as a File instance.
Returns:
A File instance.

getWsdlAsStream

InputStream getWsdlAsStream()
                            throws IOException
Get an InputStream for reading the WSDL definition with which this endpoint is associated.
Returns:
An InputStream instance for the WSDL definition contents.
Throws:
IOException

getImplementorType

String getImplementorType()
Determine the name of the web service implementor type.
Returns:
The name of the implementor type.

getEndpointAddressSubContextUri

String getEndpointAddressSubContextUri()
Get the part of the endpoint address that follows the root context.
Returns:
A String form of the URI.

getStyle

String getStyle()
Get the style of the endpoint.
Returns:
The endpoint style.

getMaxRequestSize

long getMaxRequestSize()
Determine the size of the largest request recorded thus far.
Returns:
The size of the largest request.

isRestSupported

boolean isRestSupported()
Determine whether or not REST is supported by this endpoint.
Returns:
true, if REST is supported; Otherwise, false.

isSoapSupported

boolean isSoapSupported()
Determine whether or not SOAP processing is supported by this endpoint.
Returns:
true, if SOAP is supported; Otherwise, false.

isMtomSupported

boolean isMtomSupported()
Determine whether or not MTOM is supported by this endpoint.
Returns:
true, if MTOM is supported; Otherwise, false.

getMtomThreshold

Integer getMtomThreshold()
get the MTOM threshold configured
Returns:
integer

getLoggingLevel

Level getLoggingLevel()
Determine the configured logging level for this endpoint.
Returns:
A java.util.logging.Level instance specifying the configured level.

setLoggingLevel

void setLoggingLevel(Level level)
Set the logging level for this endpoint.
Parameters:
level - A java.util.logging.Level instance specifying the desired level.

getRuntimeData

WebServiceEndpointRuntimeData getRuntimeData()
Get the runtime data associated with this endpoint.

setRuntimeData

void setRuntimeData(WebServiceEndpointRuntimeData runtimeData)
Associate the specified runtime data with this endpoint. s and
Parameters:
runtimeData - A WebServiceEndpointRuntimeData instance.

hasPolicyReference

boolean hasPolicyReference()
Test if this port has a reference to an external policy
Returns:
true if this port has an external policy reference

getEndpointIdentifier

String getEndpointIdentifier()
Gets the unique endpoint identifier
Returns:
The unique endpoint identifier of the web service endpoint represented by this object

isEnabled

boolean isEnabled()
Check if this port is enabled.
Returns:
true if enabled and false if disabled.

isSchemaValidateInput

boolean isSchemaValidateInput()
Check if schema validation is set for this port.
Returns:
true if set and false if not set or set to false.

isMexEnabled

boolean isMexEnabled()
Check if metadata exchange is allowed.
Returns:
true/false

isMtomEncodeFault

boolean isMtomEncodeFault()
Check if SOAP fault messages should be MTOM-encoded when MTOM policy is enabled.
Returns:
true/false

getSoapXml

Map<String,String> getSoapXml()
Get the configuration setting soap-xml for this endpoint.

getVersionID

String getVersionID()
Get the versionID of the endpoint. Endpoints with the same service name, port name, module name, appname are distinguished by a versionID. Null if there is no versioning implemented.

getEnvelopeLimits

Map<String,String> getEnvelopeLimits()
Get the configuration setting request-envelope-limit for this endpoint.
Returns:
string representing limit on envelope size in kilobytes or null if not set

getStreamingAttachmentsConfig

oracle.j2ee.ws.saaj.util.mime.StreamingAttachmentsConfig getStreamingAttachmentsConfig()
Get the configuration object for SAAJ streaming.
Returns:
the configuration object.

Skip navigation links

Copyright © 2006, 2009 Oracle. All Rights Reserved.