Package AccessGrid :: Module AGNodeService :: Class AGNodeServiceI
[show private | hide private]
[frames | no frames]

Class AGNodeServiceI

SOAPInterface --+
                |
               AGNodeServiceI


Interface Class for the AGNodeService


Method Summary
  __init__(self, impl)
This constructor for all SOAP Interfaces.
  AddService(self, serviceDescStruct, serviceManagerUri, resourceStruct, serviceConfigStruct)
Interface to add a service
  AddServiceManager(self, svcMgrDescStruct)
Interface to add service manager
  AddStream(self, streamDescriptionStruct)
Interface to add a stream
  GetCapabilities(self)
Interface to get a list of the node's capabilities (aggregated from its services)
  GetConfigurations(self)
Interface to get a list of node configurations
  GetDefaultConfiguration(self)
Interface to set the default node configuration
  GetServiceManagers(self)
Interface to get list of service managers
  GetServices(self)
Interface to get a list of services
  LoadConfiguration(self, configName)
Interface to load a node configuration
  MigrateNodeConfig(self, configFile)
  NeedMigrateNodeConfig(self, configFile)
  RemoveServiceManager(self, svcMgrDescStruct)
Interface to remove service manager
  RemoveStream(self, streamDescriptionStruct)
Interface to remove a stream
  SetDefaultConfiguration(self, configName)
Interface to set the default node configuration
  SetIdentity(self, profileStruct)
Interface to set the identity of the node executor
  SetServiceEnabled(self, serviceUri, enabled)
Interface to enable/disable a service
  SetServiceEnabledByMediaType(self, mediaType, enableFlag)
Interface to enable/disable services by media type
  SetStreams(self, streamDescriptionStructList)
Interface to set streams used by node
  StopServices(self)
Interface to stop services
  StoreConfiguration(self, configName)
Interface to store a node configuration
  _authorize(self, *args, **kw)
This is meant to be a base class for all SOAP interfaces, so it's going to default to disallow calls.
    Inherited from SOAPInterface
  _IsValid(self)
This method is here to support calls that just want to see if there is a valid server endpoint for communication from the client.
  IsValid(self)
This method is here to support calls that just want to see if there is a valid server endpoint for communication from the client.
  _GetCaller(self)
This method implements the guts of extracting the subject from the soap call.
  _GetContext(self)
This method implements the guts of extracting the subject and the action from the SOAP call.
  _GetMethodActions(self)
This method extracts all the methods and creates MethodActions for them, which means Authorization can be automatically loaded with actions for all the methods on an interface object.

Method Details

__init__(self, impl)
(Constructor)

This constructor for all SOAP Interfaces.

@param impl: an implementation object messages are routed to. @type impl: a python object.

Overrides:
AccessGrid.hosting.SOAPInterface.SOAPInterface.__init__ (inherited documentation)

AddService(self, serviceDescStruct, serviceManagerUri, resourceStruct, serviceConfigStruct)

Interface to add a service

Arguments:
serviceDesc Service Description of service to add serviceManagerUri The URI of the service manager to which the service should be added resourceToAssign The resource to assign to the service serviceConfig The service configuration to apply after adding the service

Raises: Returns:

AddServiceManager(self, svcMgrDescStruct)

Interface to add service manager

Arguments:
serviceManager A description of the service manager

Raises: Returns:

AddStream(self, streamDescriptionStruct)

Interface to add a stream

Arguments:
streamDescription The StreamDescription to add

Raises: Returns:

GetCapabilities(self)

Interface to get a list of the node's capabilities (aggregated from its services)

Arguments: Raises:

Returns:
a list of the capabilities of the node
(or, its services)

GetConfigurations(self)

Interface to get a list of node configurations

Arguments: Raises:

Returns:
Interface to get list of service a list of node configuration names

GetDefaultConfiguration(self)

Interface to set the default node configuration

Arguments:
configName Name of config file to use as default for the node

Raises: Returns:

GetServiceManagers(self)

Interface to get list of service managers

Arguments: Raises:

Returns:
a list of AGServiceManagerDescriptions

GetServices(self)

Interface to get a list of services

Arguments: Raises:

Returns:
a list of AGServiceDescriptions

LoadConfiguration(self, configName)

Interface to load a node configuration

Arguments:
configName Name under which to store the current configuration

Raises: Returns:

RemoveServiceManager(self, svcMgrDescStruct)

Interface to remove service manager

Arguments:
serviceManagerToRemove A description of the service manager to remove

Raises: Returns:

RemoveStream(self, streamDescriptionStruct)

Interface to remove a stream

Arguments:
streamDescription The StreamDescription to remove

Raises: Returns:

SetDefaultConfiguration(self, configName)

Interface to set the default node configuration

Arguments:
configName Name of config file to use as default for the node

Raises: Returns:

SetIdentity(self, profileStruct)

Interface to set the identity of the node executor

Arguments:
profile ClientProfile of the person commanding the node

Raises: Returns:

SetServiceEnabled(self, serviceUri, enabled)

Interface to enable/disable a service

Arguments:
serviceUri The URI of the service to enable/disable enabled Flag whether to enable/disable

Raises: Returns:

SetServiceEnabledByMediaType(self, mediaType, enableFlag)

Interface to enable/disable services by media type

Arguments:
mediaType Media type of services to enable/disable enableFlag Flag whether to enable/disable

Raises: Returns:

SetStreams(self, streamDescriptionStructList)

Interface to set streams used by node

Arguments:
streamDescriptionList List of StreamDescriptions

Raises: Returns:

StopServices(self)

Interface to stop services

Arguments: Raises: Returns:

StoreConfiguration(self, configName)

Interface to store a node configuration

Arguments:
configName Name of config file to load

Raises: Returns:

_authorize(self, *args, **kw)

This is meant to be a base class for all SOAP interfaces, so it's going to default to disallow calls. Derived interfaces can tailor this to suit their needs.

@return: 0, things are not authorized by default.

Overrides:
AccessGrid.hosting.SOAPInterface.SOAPInterface._authorize (inherited documentation)

Generated by Epydoc 2.1 on Thu Apr 14 16:39:31 2005 http://epydoc.sf.net