com.sun.xml.ws.server

Class WSEndpointMOMProxy

java.lang.Object

com.sun.xml.ws.api.server.WSEndpoint

com.sun.xml.ws.server.WSEndpointMOMProxy

All Implemented Interfaces:

Component, ComponentRegistry, Closeable, AutoCloseable, org.glassfish.gmbal.ManagedObjectManager

public class WSEndpointMOMProxy
extends WSEndpoint
implements org.glassfish.gmbal.ManagedObjectManager

ManagedObjectManager proxy class for WSEndpointImpl instances that could be used when Gmbal API calls need to be deferred. The proxy tries to defer a need of a real ManagedObjectManager instance to the time when any method from ManagedObjectManager is invoked on it. In this case a real instance of ManagedObjectManager is obtained from WSEndpointImpl and the method is rather invoked on this object.

Nested Class Summary

Nested classes/interfaces inherited from class com.sun.xml.ws.api.server.WSEndpoint

WSEndpoint.CompletionCallback, WSEndpoint.PipeHead

Nested classes/interfaces inherited from interface org.glassfish.gmbal.ManagedObjectManager

org.glassfish.gmbal.ManagedObjectManager.RegistrationDebugLevel

Constructor Summary

Constructors

Constructor and Description
WSEndpointMOMProxy(WSEndpointImpl wsEndpoint)

Method Summary

Methods

Modifier and Type	Method and Description
void	addAnnotation(AnnotatedElement element, Annotation annotation)
void	addInheritedAnnotations(Class<?> clazz)
void	close()
void	closeManagedObjectManager() Close the ManagedObjectManager for this endpoint.
Codec	createCodec() Gets the Endpoint's codec that is used to encode/decode Messages.
WSEndpoint.PipeHead	createPipeHead() Creates a new WSEndpoint.PipeHead to process incoming requests.
org.glassfish.gmbal.GmbalMBean	createRoot()
org.glassfish.gmbal.GmbalMBean	createRoot(Object root)
org.glassfish.gmbal.GmbalMBean	createRoot(Object root, String name)
void	dispose() Indicates that the WSEndpoint is about to be turned off, and will no longer serve any packet anymore.
String	dumpSkeleton(Object obj)
boolean	equalsProxiedInstance(WSEndpoint endpoint) Used for managed endpoints infrastructure to compare equality of proxies vs proxied endpoints.
org.glassfish.gmbal.AMXClient	getAMXClient(Object obj)
ServerTubeAssemblerContext	getAssemblerContext() This is only needed to expose info for monitoring.
WSBinding	getBinding() Represents the binding for which this WSEndpoint is created for.
Set	getComponentRegistry() Gets the list of EndpointComponent that are associated with this endpoint.
Container	getContainer() Gets the Container object.
String	getDomain()
EndpointReference	getEndpointReference(Class clazz, String address, String wsdlAddress, Element... referenceParameters) Return EndpointReference instance, based on passed parameters and spec version represented by clazz
EndpointReference	getEndpointReference(Class clazz, String address, String wsdlAddress, List metadata, List referenceParameters)
Class	getImplementationClass() Gets the application endpoint Class that eventually serves the request.
org.glassfish.gmbal.ManagedObjectManager	getManagedObjectManager() Returns a real instance of ManagedObjectManager
MBeanServer	getMBeanServer()
Object	getObject(ObjectName oname)
ObjectName	getObjectName(Object obj)
org.glassfish.pfl.tf.timer.spi.ObjectRegistrationManager	getObjectRegistrationManager()
OperationDispatcher	getOperationDispatcher() Nullable when there is no associated WSDL Model
com.sun.xml.ws.policy.PolicyMap	getPolicyMap() Gives the PolicMap that captures the Policy for the endpoint
WSDLPort	getPort() Gets the port that this endpoint is serving.
QName	getPortName() Gets the application endpoint's portName.
ResourceBundle	getResourceBundle()
Object	getRoot()
SEIModel	getSEIModel() Gets the SEIModel that represents the relationship between WSDL and Java SEI.
ServiceDefinition	getServiceDefinition() Gets the description of the service.
QName	getServiceName() Gets the application endpoint's serviceName.
WSEndpointImpl	getWsEndpoint()
boolean	isInitialized() Returns true if this proxy contains a reference to real ManagedObjectManager instance, false otherwise.
boolean	isManagedObject(Object obj)
org.glassfish.gmbal.GmbalMBean	register(Object parent, Object obj)
org.glassfish.gmbal.GmbalMBean	register(Object parent, Object obj, String name)
org.glassfish.gmbal.GmbalMBean	registerAtRoot(Object obj)
org.glassfish.gmbal.GmbalMBean	registerAtRoot(Object obj, String name)
void	resumeJMXRegistration()
void	schedule(Packet request, WSEndpoint.CompletionCallback callback, FiberContextSwitchInterceptor interceptor) Schedule invocation of web service asynchronously.
void	setExecutor(Executor exec) Set this Executor to run asynchronous requests using this executor.
void	setJMXRegistrationDebug(boolean flag)
(package private) void	setManagedObjectManager(org.glassfish.gmbal.ManagedObjectManager managedObjectManager)
void	setMBeanServer(MBeanServer server)
void	setRegistrationDebug(org.glassfish.gmbal.ManagedObjectManager.RegistrationDebugLevel level)
void	setResourceBundle(ResourceBundle rb)
void	setRuntimeDebug(boolean flag)
void	setTypelibDebug(int level)
void	stripPackagePrefix()
void	stripPrefix(String... str)
void	suppressDuplicateRootReport(boolean suppressReport)
void	suspendJMXRegistration()
void	unregister(Object obj)

Methods inherited from class com.sun.xml.ws.api.server.WSEndpoint

create, create, create, create, getBoundEndpoints, getComponents, getDefaultPortName, getDefaultPortName, getDefaultServiceName, getDefaultServiceName, getEngine, getSPI, process, schedule

Methods inherited from class java.lang.Object

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

Constructor Detail

WSEndpointMOMProxy

WSEndpointMOMProxy(@NotNull
                  WSEndpointImpl wsEndpoint)

Method Detail

getManagedObjectManager

public org.glassfish.gmbal.ManagedObjectManager getManagedObjectManager()

Returns a real instance of ManagedObjectManager

Specified by:

getManagedObjectManager in class WSEndpoint

Returns:

an ManagedObjectManager instance

setManagedObjectManager

void setManagedObjectManager(org.glassfish.gmbal.ManagedObjectManager managedObjectManager)

isInitialized

public boolean isInitialized()

Returns true if this proxy contains a reference to real ManagedObjectManager instance, false otherwise.

Returns:

true if ManagedObjectManager has been created, false otherwise.

getWsEndpoint

public WSEndpointImpl getWsEndpoint()

suspendJMXRegistration

public void suspendJMXRegistration()

Specified by:

suspendJMXRegistration in interface org.glassfish.gmbal.ManagedObjectManager

resumeJMXRegistration

public void resumeJMXRegistration()

Specified by:

resumeJMXRegistration in interface org.glassfish.gmbal.ManagedObjectManager

isManagedObject

public boolean isManagedObject(Object obj)

Specified by:

isManagedObject in interface org.glassfish.gmbal.ManagedObjectManager

createRoot

public org.glassfish.gmbal.GmbalMBean createRoot()

Specified by:

createRoot in interface org.glassfish.gmbal.ManagedObjectManager

createRoot

public org.glassfish.gmbal.GmbalMBean createRoot(Object root)

Specified by:

createRoot in interface org.glassfish.gmbal.ManagedObjectManager

createRoot

public org.glassfish.gmbal.GmbalMBean createRoot(Object root,
                                        String name)

Specified by:

createRoot in interface org.glassfish.gmbal.ManagedObjectManager

getRoot

public Object getRoot()

Specified by:

getRoot in interface org.glassfish.gmbal.ManagedObjectManager

register

public org.glassfish.gmbal.GmbalMBean register(Object parent,
                                      Object obj,
                                      String name)

Specified by:

register in interface org.glassfish.gmbal.ManagedObjectManager

register

public org.glassfish.gmbal.GmbalMBean register(Object parent,
                                      Object obj)

Specified by:

register in interface org.glassfish.gmbal.ManagedObjectManager

registerAtRoot

public org.glassfish.gmbal.GmbalMBean registerAtRoot(Object obj,
                                            String name)

Specified by:

registerAtRoot in interface org.glassfish.gmbal.ManagedObjectManager

registerAtRoot

public org.glassfish.gmbal.GmbalMBean registerAtRoot(Object obj)

Specified by:

registerAtRoot in interface org.glassfish.gmbal.ManagedObjectManager

unregister

public void unregister(Object obj)

Specified by:

unregister in interface org.glassfish.gmbal.ManagedObjectManager

getObjectName

public ObjectName getObjectName(Object obj)

Specified by:

getObjectName in interface org.glassfish.gmbal.ManagedObjectManager

getAMXClient

public org.glassfish.gmbal.AMXClient getAMXClient(Object obj)

Specified by:

getAMXClient in interface org.glassfish.gmbal.ManagedObjectManager

getObject

public Object getObject(ObjectName oname)

Specified by:

getObject in interface org.glassfish.gmbal.ManagedObjectManager

stripPrefix

public void stripPrefix(String... str)

Specified by:

stripPrefix in interface org.glassfish.gmbal.ManagedObjectManager

stripPackagePrefix

public void stripPackagePrefix()

Specified by:

stripPackagePrefix in interface org.glassfish.gmbal.ManagedObjectManager

getDomain

public String getDomain()

Specified by:

getDomain in interface org.glassfish.gmbal.ManagedObjectManager

setMBeanServer

public void setMBeanServer(MBeanServer server)

Specified by:

setMBeanServer in interface org.glassfish.gmbal.ManagedObjectManager

getMBeanServer

public MBeanServer getMBeanServer()

Specified by:

getMBeanServer in interface org.glassfish.gmbal.ManagedObjectManager

setResourceBundle

public void setResourceBundle(ResourceBundle rb)

Specified by:

setResourceBundle in interface org.glassfish.gmbal.ManagedObjectManager

getResourceBundle

public ResourceBundle getResourceBundle()

Specified by:

getResourceBundle in interface org.glassfish.gmbal.ManagedObjectManager

addAnnotation

public void addAnnotation(AnnotatedElement element,
                 Annotation annotation)

Specified by:

addAnnotation in interface org.glassfish.gmbal.ManagedObjectManager

setRegistrationDebug

public void setRegistrationDebug(org.glassfish.gmbal.ManagedObjectManager.RegistrationDebugLevel level)

Specified by:

setRegistrationDebug in interface org.glassfish.gmbal.ManagedObjectManager

setRuntimeDebug

public void setRuntimeDebug(boolean flag)

Specified by:

setRuntimeDebug in interface org.glassfish.gmbal.ManagedObjectManager

setTypelibDebug

public void setTypelibDebug(int level)

Specified by:

setTypelibDebug in interface org.glassfish.gmbal.ManagedObjectManager

setJMXRegistrationDebug

public void setJMXRegistrationDebug(boolean flag)

Specified by:

setJMXRegistrationDebug in interface org.glassfish.gmbal.ManagedObjectManager

dumpSkeleton

public String dumpSkeleton(Object obj)

Specified by:

dumpSkeleton in interface org.glassfish.gmbal.ManagedObjectManager

suppressDuplicateRootReport

public void suppressDuplicateRootReport(boolean suppressReport)

Specified by:

suppressDuplicateRootReport in interface org.glassfish.gmbal.ManagedObjectManager

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

equalsProxiedInstance

public boolean equalsProxiedInstance(WSEndpoint endpoint)

Description copied from class: WSEndpoint

Used for managed endpoints infrastructure to compare equality of proxies vs proxied endpoints.

Overrides:

equalsProxiedInstance in class WSEndpoint

Returns:

true if the proxied endpoint instance held by this instance equals to 'endpoint', otherwise return false.

createCodec

public Codec createCodec()

Description copied from class: WSEndpoint

Gets the Endpoint's codec that is used to encode/decode Messages. This is a copy of the master codec and it shouldn't be shared across two requests running concurrently(unless it is stateless).

Specified by:

createCodec in class WSEndpoint

Returns:

codec to encode/decode

getServiceName

public QName getServiceName()

Description copied from class: WSEndpoint

Gets the application endpoint's serviceName. It could be got from DD or annotations

Specified by:

getServiceName in class WSEndpoint

Returns:

same as wsdl:service QName if WSDL exists or generated

getPortName

public QName getPortName()

Description copied from class: WSEndpoint

Gets the application endpoint's portName. It could be got from DD or annotations

Specified by:

getPortName in class WSEndpoint

Returns:

same as wsdl:port QName if WSDL exists or generated

getImplementationClass

public Class getImplementationClass()

Description copied from class: WSEndpoint

Gets the application endpoint Class that eventually serves the request.

This is the same value given to the WSEndpoint.create(java.lang.Class<T>, boolean, com.sun.xml.ws.api.server.Invoker, javax.xml.namespace.QName, javax.xml.namespace.QName, com.sun.xml.ws.api.server.Container, com.sun.xml.ws.api.WSBinding, com.sun.xml.ws.api.server.SDDocumentSource, java.util.Collection<? extends com.sun.xml.ws.api.server.SDDocumentSource>, org.xml.sax.EntityResolver, boolean) method.

Specified by:

getImplementationClass in class WSEndpoint

getBinding

public WSBinding getBinding()

Description copied from class: WSEndpoint

Represents the binding for which this WSEndpoint is created for.

Specified by:

getBinding in class WSEndpoint

Returns:

always same object.

getContainer

public Container getContainer()

Description copied from class: WSEndpoint

Gets the Container object.

The components inside WSEndpoint uses this reference to communicate with the hosting environment.

Specified by:

getContainer in class WSEndpoint

Returns:

always same object. If no "real" Container instance is given, Container.NONE will be returned.

getPort

public WSDLPort getPort()

Description copied from class: WSEndpoint

Gets the port that this endpoint is serving.

A service is not required to have a WSDL, and when it doesn't, this method returns null. Otherwise it returns an object that describes the port that this WSEndpoint is serving.

Specified by:

getPort in class WSEndpoint

Returns:

Possibly null, but always the same value.

setExecutor

public void setExecutor(Executor exec)

Description copied from class: WSEndpoint

Set this Executor to run asynchronous requests using this executor. This executor is set on Engine and must be set before calling WSEndpoint.schedule(Packet,CompletionCallback) and WSEndpoint.schedule(Packet,CompletionCallback,FiberContextSwitchInterceptor) methods.

Specified by:

setExecutor in class WSEndpoint

Parameters:

exec - Executor to run async requests

schedule

public void schedule(Packet request,
            WSEndpoint.CompletionCallback callback,
            FiberContextSwitchInterceptor interceptor)

Description copied from class: WSEndpoint

Schedule invocation of web service asynchronously.

Specified by:

schedule in class WSEndpoint

Parameters:

request - web service request

callback - callback to get response packet(exception if there is one)

interceptor - caller's interceptor to impose a context of execution

See Also:

#schedule(Packet, CompletionCallback)}

createPipeHead

public WSEndpoint.PipeHead createPipeHead()

Description copied from class: WSEndpoint

Creates a new WSEndpoint.PipeHead to process incoming requests.

This is not a cheap operation. The caller is expected to reuse the returned WSEndpoint.PipeHead. See class javadoc for details.

Specified by:

createPipeHead in class WSEndpoint

Returns:

A newly created WSEndpoint.PipeHead that's ready to serve.

dispose

public void dispose()

Description copied from class: WSEndpoint

Indicates that the WSEndpoint is about to be turned off, and will no longer serve any packet anymore.

This method needs to be invoked for the JAX-WS RI to correctly implement some of the spec semantics (TODO: pointer.) It's the responsibility of the code that hosts a WSEndpoint to invoke this method.

Once this method is called, the behavior is undefed for all in-progress WSEndpoint.PipeHead.process(com.sun.xml.ws.api.message.Packet, com.sun.xml.ws.api.server.WebServiceContextDelegate, com.sun.xml.ws.api.server.TransportBackChannel) methods (by other threads) and future WSEndpoint.PipeHead.process(com.sun.xml.ws.api.message.Packet, com.sun.xml.ws.api.server.WebServiceContextDelegate, com.sun.xml.ws.api.server.TransportBackChannel) method invocations.

Specified by:

dispose in class WSEndpoint

getServiceDefinition

public ServiceDefinition getServiceDefinition()

Description copied from class: WSEndpoint

Gets the description of the service.

A description is a set of WSDL/schema and other documents that together describes a service. A service is not required to have a description, and when it doesn't, this method returns null.

Specified by:

getServiceDefinition in class WSEndpoint

Returns:

Possibly null, always the same value under ordinary circumstances but may change if the endpoint is managed.

getComponentRegistry

public Set getComponentRegistry()

Description copied from class: WSEndpoint

Gets the list of EndpointComponent that are associated with this endpoint.

Components (such as codec, tube, handler, etc) who wish to provide some service to other components in the endpoint can iterate the registry and call its EndpointComponent.getSPI(Class) to establish a private contract between components.

Components who wish to subscribe to such a service can add itself to this set.

Specified by:

getComponentRegistry in class WSEndpoint

Returns:

always return the same set.

getSEIModel

public SEIModel getSEIModel()

Description copied from class: WSEndpoint

Gets the SEIModel that represents the relationship between WSDL and Java SEI.

This method returns a non-null value if and only if this endpoint is ultimately serving an application through an SEI.

Specified by:

getSEIModel in class WSEndpoint

Returns:

maybe null. See above for more discussion. Always the same value.

getPolicyMap

public com.sun.xml.ws.policy.PolicyMap getPolicyMap()

Description copied from class: WSEndpoint

Gives the PolicMap that captures the Policy for the endpoint

Specified by:

getPolicyMap in class WSEndpoint

Returns:

PolicyMap

closeManagedObjectManager

public void closeManagedObjectManager()

Description copied from class: WSEndpoint

Close the ManagedObjectManager for this endpoint. This is used by the Web Service Configuration Management system so that it closes the MOM before it creates a new WSEndpoint. Then it calls dispose on the existing endpoint and then installs the new endpoint. The call to dispose also calls closeManagedObjectManager, but is a noop if that method has already been called.

Specified by:

closeManagedObjectManager in class WSEndpoint

getAssemblerContext

public ServerTubeAssemblerContext getAssemblerContext()

Description copied from class: WSEndpoint

This is only needed to expose info for monitoring.

Specified by:

getAssemblerContext in class WSEndpoint

getEndpointReference

public EndpointReference getEndpointReference(Class clazz,
                                     String address,
                                     String wsdlAddress,
                                     Element... referenceParameters)

Description copied from class: WSEndpoint

Return EndpointReference instance, based on passed parameters and spec version represented by clazz

Specified by:

getEndpointReference in class WSEndpoint

Parameters:

clazz - represents spec version

address - endpoint address

wsdlAddress - wsdl address

referenceParameters - any reference parameters to be added to the instance

Returns:

EndpointReference instance based on passed parameters and values obtained from current instance

getEndpointReference

public EndpointReference getEndpointReference(Class clazz,
                                     String address,
                                     String wsdlAddress,
                                     List metadata,
                                     List referenceParameters)

Specified by:

getEndpointReference in class WSEndpoint

Returns:

getOperationDispatcher

public OperationDispatcher getOperationDispatcher()

Description copied from class: WSEndpoint

Nullable when there is no associated WSDL Model

Specified by:

getOperationDispatcher in class WSEndpoint

Returns:

getObjectRegistrationManager

public org.glassfish.pfl.tf.timer.spi.ObjectRegistrationManager getObjectRegistrationManager()

Specified by:

getObjectRegistrationManager in interface org.glassfish.gmbal.ManagedObjectManager

addInheritedAnnotations

public void addInheritedAnnotations(Class<?> clazz)

Specified by:

addInheritedAnnotations in interface org.glassfish.gmbal.ManagedObjectManager