org.apache.axis.deployment
Class DeploymentRegistry

java.lang.Object
  |
  +--org.apache.axis.deployment.DeploymentRegistry
All Implemented Interfaces:
java.io.Serializable

public abstract class DeploymentRegistry
extends java.lang.Object
implements java.io.Serializable

The DeploymentRegistry abstract class takes the place of the org.apache.axis.registry.HandlerRegistry and extends the functionality to cover all Axis deployable items.

Author:
James Snell
See Also:
Serialized Form

Constructor Summary
DeploymentRegistry()
           
 
Method Summary
abstract  void addTypeMapping(java.lang.String encodingStyle, TypeMapping tm)
          add the given type mapping
abstract  void deploy(DeploymentDocument deployment)
          Deploy an Axis WSDD Document
abstract  void deployHandler(DeployableItem item)
          deploy the given handler
abstract  void deployHandler(java.lang.String key, Handler handler)
          Deploy a Handler into the registry.
abstract  void deployItem(DeployableItem item)
          deploy the given item
abstract  void deployService(DeployableItem item)
          deploy the given service
abstract  void deployService(java.lang.String key, SOAPService service)
          deploy the given service
abstract  void deployTransport(DeployableItem item)
          deploy the given transport
abstract  void deployTransport(java.lang.String key, SimpleTargetedChain transport)
          deploy the given transport
abstract  java.util.Hashtable getGlobalOptions()
          Returns the global configuration options.
abstract  Handler getGlobalRequest()
          Returns a global request handler.
abstract  Handler getGlobalResponse()
          Returns a global response handler.
abstract  Handler getHandler(QName qname)
          retrieve an instance of the named handler
abstract  DeployableItem getHandlerDeployableItem(QName qname)
          retrieve a deployment item of the named handler
abstract  java.util.Enumeration getHandlers()
          Returns an Enumeration of the QNames for the list of deployed handlers
abstract  Handler getService(QName qname)
          retrieve an instance of the named service
abstract  DeployableItem getServiceDeployableItem(QName qname)
          retrieve a deployment item of the named service
abstract  java.util.Enumeration getServices()
          Returns an Enumeration of the QNames for the list of deployed services
abstract  Handler getTransport(QName qname)
          retrieve an instance of the named transport
abstract  DeployableItem getTransportDeployableItem(QName qname)
          retrieve a deployment item of the named transport
abstract  java.util.Enumeration getTransports()
          Returns an Enumeration of the QNames for the list of deployed transports
abstract  TypeMapping getTypeMapping(java.lang.String encodingStyle)
          retrieve an instance of the named type mapping
abstract  TypeMappingRegistry getTypeMappingRegistry()
          retrieve an instance of the named type mapping registry
static DeploymentRegistry load(java.io.InputStream in)
          load a registry from the given inputstream
static DeploymentRegistry load(java.lang.String filename)
          load a registry from the given filepath
abstract  void removeDeployedItem(QName qname)
          remove the given item
abstract  void removeTypeMapping(java.lang.String encodingStyle)
          remove the given type mapping
 void save(java.io.OutputStream out)
          Save the registry to the given outputstream
static void save(java.io.OutputStream out, DeploymentRegistry registry)
          save the given registry to the given output stream
 void save(java.lang.String filename)
          Save the registry to the given filepath
static void save(java.lang.String filename, DeploymentRegistry registry)
          Save the given registry to the given filepath
abstract  void setGlobalConfiguration(WSDDGlobalConfiguration global)
          set the global configuration for the axis engine
abstract  void undeployHandler(QName qname)
          remove the given handler
abstract  void undeployHandler(java.lang.String key)
          Remove the specified handler.
abstract  void undeployService(QName qname)
          remove the given service
abstract  void undeployService(java.lang.String key)
          remove the given service
abstract  void undeployTransport(QName qname)
          remove the given transport
abstract  void undeployTransport(java.lang.String key)
          remove the given transport
abstract  void writeToContext(SerializationContext context)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DeploymentRegistry

public DeploymentRegistry()
Method Detail

getHandler

public abstract Handler getHandler(QName qname)
                            throws DeploymentException
retrieve an instance of the named handler
Parameters:
qname - XXX
Returns:
XXX
Throws:
DeploymentException - XXX

getHandlerDeployableItem

public abstract DeployableItem getHandlerDeployableItem(QName qname)
                                                 throws DeploymentException
retrieve a deployment item of the named handler
Parameters:
qname - XXX
Returns:
XXX
Throws:
DeploymentException - XXX

getService

public abstract Handler getService(QName qname)
                            throws DeploymentException
retrieve an instance of the named service
Parameters:
qname - XXX
Returns:
XXX
Throws:
DeploymentException - XXX

getServiceDeployableItem

public abstract DeployableItem getServiceDeployableItem(QName qname)
                                                 throws DeploymentException
retrieve a deployment item of the named service
Parameters:
qname - XXX
Returns:
XXX
Throws:
DeploymentException - XXX

getTransport

public abstract Handler getTransport(QName qname)
                              throws DeploymentException
retrieve an instance of the named transport
Parameters:
qname - XXX
Returns:
XXX
Throws:
DeploymentException - XXX

getTransportDeployableItem

public abstract DeployableItem getTransportDeployableItem(QName qname)
                                                   throws DeploymentException
retrieve a deployment item of the named transport
Parameters:
qname - XXX
Returns:
XXX
Throws:
DeploymentException - XXX

getTypeMappingRegistry

public abstract TypeMappingRegistry getTypeMappingRegistry()
retrieve an instance of the named type mapping registry
Returns:
TypeMappingRegistery

getTypeMapping

public abstract TypeMapping getTypeMapping(java.lang.String encodingStyle)
                                    throws DeploymentException
retrieve an instance of the named type mapping
Parameters:
encodingStyle - XXX
Returns:
XXX
Throws:
DeploymentException - XXX

addTypeMapping

public abstract void addTypeMapping(java.lang.String encodingStyle,
                                    TypeMapping tm)
                             throws DeploymentException
add the given type mapping
Parameters:
encodingStyle - XXX
tmr - XXX
Throws:
DeploymentException - XXX

removeTypeMapping

public abstract void removeTypeMapping(java.lang.String encodingStyle)
                                throws DeploymentException
remove the given type mapping
Parameters:
encodingStyle - XXX
Throws:
DeploymentException - XXX

deploy

public abstract void deploy(DeploymentDocument deployment)
                     throws DeploymentException
Deploy an Axis WSDD Document
Parameters:
deployment - XXX
Throws:
DeploymentException - XXX

deployItem

public abstract void deployItem(DeployableItem item)
                         throws DeploymentException
deploy the given item
Parameters:
item - XXX
Throws:
DeploymentException - XXX

deployService

public abstract void deployService(DeployableItem item)
                            throws DeploymentException
deploy the given service
Parameters:
item - XXX
Throws:
DeploymentException - XXX

deployService

public abstract void deployService(java.lang.String key,
                                   SOAPService service)
                            throws DeploymentException
deploy the given service
Parameters:
key - XXX
service - XXX
Throws:
DeploymentException - XXX

deployHandler

public abstract void deployHandler(DeployableItem item)
                            throws DeploymentException
deploy the given handler
Parameters:
item - XXX
Throws:
DeploymentException - XXX

deployHandler

public abstract void deployHandler(java.lang.String key,
                                   Handler handler)
                            throws DeploymentException
Deploy a Handler into the registry.
Parameters:
key - XXX
handler - XXX
Throws:
DeploymentException - XXX

deployTransport

public abstract void deployTransport(DeployableItem item)
                              throws DeploymentException
deploy the given transport
Parameters:
item - XXX
Throws:
DeploymentException - XXX

deployTransport

public abstract void deployTransport(java.lang.String key,
                                     SimpleTargetedChain transport)
                              throws DeploymentException
deploy the given transport
Parameters:
key - XXX
transport - XXX
Throws:
DeploymentException - XXX

removeDeployedItem

public abstract void removeDeployedItem(QName qname)
                                 throws DeploymentException
remove the given item
Parameters:
qname - XXX
Throws:
DeploymentException - XXX

undeployHandler

public abstract void undeployHandler(QName qname)
                              throws DeploymentException
remove the given handler
Parameters:
qname - XXX
Throws:
DeploymentException - XXX

undeployHandler

public abstract void undeployHandler(java.lang.String key)
                              throws DeploymentException
Remove the specified handler.
Parameters:
key - XXX
Throws:
DeploymentException - XXX

undeployService

public abstract void undeployService(QName qname)
                              throws DeploymentException
remove the given service
Parameters:
qname - XXX
Throws:
DeploymentException - XXX

undeployService

public abstract void undeployService(java.lang.String key)
                              throws DeploymentException
remove the given service
Parameters:
key - XXX
Throws:
DeploymentException - XXX

undeployTransport

public abstract void undeployTransport(QName qname)
                                throws DeploymentException
remove the given transport
Parameters:
qname - XXX
Throws:
DeploymentException - XXX

undeployTransport

public abstract void undeployTransport(java.lang.String key)
                                throws DeploymentException
remove the given transport
Parameters:
key - XXX
Throws:
DeploymentException - XXX

setGlobalConfiguration

public abstract void setGlobalConfiguration(WSDDGlobalConfiguration global)
set the global configuration for the axis engine
Parameters:
global - XXX

writeToContext

public abstract void writeToContext(SerializationContext context)
                             throws java.io.IOException

save

public void save(java.lang.String filename)
          throws java.io.IOException
Save the registry to the given filepath
Parameters:
filename - XXX
Throws:
java.io.IOException - XXX

save

public void save(java.io.OutputStream out)
          throws java.io.IOException
Save the registry to the given outputstream
Parameters:
out - XXX
Throws:
java.io.IOException - XXX

save

public static void save(java.lang.String filename,
                        DeploymentRegistry registry)
                 throws java.io.IOException
Save the given registry to the given filepath
Parameters:
filename - XXX
registry - XXX
Throws:
java.io.IOException - XXX

save

public static void save(java.io.OutputStream out,
                        DeploymentRegistry registry)
                 throws java.io.IOException
save the given registry to the given output stream
Parameters:
out - XXX
registry - XXX
Throws:
java.io.IOException - XXX

load

public static DeploymentRegistry load(java.lang.String filename)
                               throws java.io.IOException
load a registry from the given filepath
Parameters:
filename - XXX
Returns:
XXX
Throws:
java.io.IOException - XXX

load

public static DeploymentRegistry load(java.io.InputStream in)
                               throws java.io.IOException
load a registry from the given inputstream
Parameters:
in - XXX
Returns:
XXX
Throws:
java.io.IOException - XXX

getServices

public abstract java.util.Enumeration getServices()
                                           throws DeploymentException
Returns an Enumeration of the QNames for the list of deployed services
Returns:
Enumeration of QNames
Throws:
DeploymentException -  

getHandlers

public abstract java.util.Enumeration getHandlers()
                                           throws DeploymentException
Returns an Enumeration of the QNames for the list of deployed handlers
Returns:
Enumeration of QNames
Throws:
DeploymentException -  

getTransports

public abstract java.util.Enumeration getTransports()
                                             throws DeploymentException
Returns an Enumeration of the QNames for the list of deployed transports
Returns:
Enumeration of QNames
Throws:
DeploymentException -  

getGlobalRequest

public abstract Handler getGlobalRequest()
                                  throws DeploymentException
Returns a global request handler.

getGlobalResponse

public abstract Handler getGlobalResponse()
                                   throws DeploymentException
Returns a global response handler.

getGlobalOptions

public abstract java.util.Hashtable getGlobalOptions()
Returns the global configuration options.


Copyright © 2001 Apache XML Project. All Rights Reserved.