Openwings API Documentation (v1.1)
A B C D E F G H I L M N O P R S T U V Y

A

ACTIVE - Static variable in class net.openwings.availability.UnitReport
This constant is used to indicate that a unit is active.
AUTHENTICATED - Static variable in class net.openwings.install.InstallableComponentDescriptor
This is the state of a component which has been downloaded and authenticated but not yet resolved or installed.
AsynchronousConnector - class net.openwings.connector.asynchronous.AsynchronousConnector.
This class contains the proxies for an asynchronous connector.
AsynchronousConnector() - Constructor for class net.openwings.connector.asynchronous.AsynchronousConnector
Default constructor
AsynchronousConnector(ProtocolAttributes) - Constructor for class net.openwings.connector.asynchronous.AsynchronousConnector
This constructor allows the protocol-specific attributes to be passed
Attribute - class net.openwings.identity.Attribute.
This class is a universal attribute used throughout Openwings.
Attribute() - Constructor for class net.openwings.identity.Attribute
Default constructor
Attribute(String, Object) - Constructor for class net.openwings.identity.Attribute
This simple constructor creates an Attribute with the given name and value.
AvailabilityMBean - interface net.openwings.availability.AvailabilityMBean.
This class is the availability Management Bean interface.
addConnectionListener(ConnectionListener) - Method in interface net.openwings.connector.synchronous.ProviderProxy
This method establishes a callback for a ConnectionListener.
addException(Exception) - Method in class net.openwings.connector.ConnectorCompilerExceptions
This method adds an exception to the collection of raised exceptions.
addException(Exception) - Method in class net.openwings.connector.ConnectorGeneratorExceptions
This method adds an exception to the collection of raised exceptions.
addHeartbeatListener(HeartbeatListener, float) - Method in interface net.openwings.availability.AvailabilityMBean
This method is used to add a listener that receives periodic heartbeat events.
addInstallListener(InstallListener) - Method in interface net.openwings.install.Installer
This method is used to add an installation listener.
addListener(VisibleListener) - Method in interface net.openwings.availability.Visible
This method adds a listener for that wants to know a change in a connection's online/offline status.
addMBean(MBean) - Method in interface net.openwings.management.Manager
This method adds an MBean to this Manager.
addMBeanAdapter(MBeanAdapter) - Method in interface net.openwings.management.Manager
This method adds an MBeanAdapter to this Manager.
addManagerListener(ManagerListener) - Method in interface net.openwings.management.RemoteManager
This method registers an ManagerListener which will be notified when MBeans are added or removed from this Manager.
addPackageMapping(Class, String) - Method in interface net.openwings.policy.PolicyLoader
This method adds a mapping of a Policy interface to a package where a suitable implementation class may be found.
addPerformanceReportListener(PerformanceReportListener, float) - Method in interface net.openwings.availability.AvailabilityMBean
This method is used to add a listener that receives periodic performance updates.
addPlatform(UniqueID, String, boolean) - Method in interface net.openwings.context.Context
This method is used to add a platform to the context.
addPlatformListener(PlatformListener) - Method in interface net.openwings.context.Context
This method is used to add a listener that is notified when platforms are added to the context or deleted from the Context.
addPolicyListener(PolicyListener) - Method in interface net.openwings.context.Context
This method is used to add a listener that is notified when policies are added, changed, or deleted in a context.
addPropertyListener(PropertyListener) - Method in interface net.openwings.context.Context
This method is used to add a listener that is notified when properties are added, changed, or deleted in a Context.
addPublisherUIFactory(UserInterfaceFactory) - Method in class net.openwings.component.PublishServiceParameters
This convenience method adds a factory
addRelationship(UniqueID, String) - Method in interface net.openwings.context.Context
This method is used to add relationships between this context and another.
addRelationship(String, Certificate[]) - Method in interface net.openwings.security.SecurityService
This method is used to establish a trust relationship between two platforms.
addRelationshipListener(RelationshipListener) - Method in interface net.openwings.context.Context
This method is used to add a listener that is notified when context relationships are added or removed.
addRequiredAttribute(Attribute) - Method in class net.openwings.component.EventServiceParameters
This convenience method adds a service attribute
addRequiredAttribute(Attribute) - Method in class net.openwings.component.UseServiceParameters
This convenience method adds a service attribute
addRole(String) - Method in interface net.openwings.security.SecurityService
This method adds the specified role to the system.
addRunnableProcess(ComponentDescriptor) - Method in interface net.openwings.container.ContainerManagerMBean
This method adds a process to the list of processes the ContainerManager is able to run.
addRunnableProcesses(UniqueID, ComponentDescriptor[]) - Method in interface net.openwings.container.ContainerManagerListener
This method should be called when a ContainerManager has new processes (components) that it is able to run.
addServiceAttribute(Attribute) - Method in class net.openwings.component.ProvideServiceParameters
This convenience method adds a service attribute
addServiceAttribute(Attribute) - Method in class net.openwings.component.PublishServiceParameters
This convenience method adds a service attribute
addSignerCertificate(Certificate[]) - Method in interface net.openwings.security.SecurityService
This method is used to import signer certificates into the system.
addSubscriberUIFactory(UserInterfaceFactory) - Method in class net.openwings.component.PublishServiceParameters
This convenience method adds a factory
addUnitReportListener(UnitReportListener) - Method in interface net.openwings.availability.AvailabilityMBean
This method is used to add a listener that receives unit fault reports.
addUser(String, String[], String) - Method in interface net.openwings.security.SecurityService
This method adds a user to the system.
addUserInterfaceFactory(UserInterfaceFactory) - Method in class net.openwings.component.ProvideServiceParameters
This convenience method adds a factory
addUserInterfaceFactory(UserInterfaceFactory) - Method in interface net.openwings.management.Manager
This method adds a user interface factory to this Manager.
addUserToRole(String, String) - Method in interface net.openwings.security.SecurityService
This method assigns a role to a user.
addVoter(Voter) - Method in interface net.openwings.install.Installer
This method is used to add a voter to vote on removal of components.
assignProcess(ComponentDescriptor, LoadBalancerContainerInfo[]) - Method in interface net.openwings.container.utilities.LoadBalancer
This method allocates a process to a container.
asynchronousInterfaceCheck(Class) - Static method in class net.openwings.service.ServiceInterfaceChecker
This method checks that a asynchronous interface is a valid service interface.
attributes - Variable in class net.openwings.connector.Connector
This field contains any protocol-specific information used to configure the connector.

B

BACKUP - Static variable in class net.openwings.availability.UnitReport
This constant is used to indicate that a unit is a backup unit.
BIN_DIR - Static variable in class net.openwings.install.InstallableComponentDescriptor
This is the name of a property used to reference the file URL location of a component's bin directory.
balanceLoad(LoadBalancerContainerInfo[]) - Method in interface net.openwings.container.utilities.LoadBalancer
This method generates instructions for balancing the load between containers.
buildUserInterface(Object, Class, Object[], UserInterfaceFactory) - Method in interface net.openwings.ui.UserInterfaceBuilder
This method is used to build a user interface for a service object using a specified user interface factory.
buildUserInterface(Class, Object, Class, Object[]) - Method in interface net.openwings.ui.UserInterfaceBuilder
This method is used to build a user interface for a service object with no user interface factory specified.

C

CLUSTER - Static variable in interface net.openwings.container.ContainerAttributeConstants
This constant is the name of an attribute which is used to indicate the cluster of a ClusteredContainerManager service.
CONTAINER_ID_PROPERTY - Static variable in interface net.openwings.container.ContainerAttributeConstants
This constant is the name of an property that represents the unique identifier for a Container.
CONTAINER_MANAGER_ID_PROPERTY - Static variable in interface net.openwings.container.ContainerAttributeConstants
This constant is the name of an property that represents the unique identifier of a ContainerManager.
CONTAINER_ONLY - Static variable in interface net.openwings.container.ContainerAttributeConstants
This constant is the name of an attribute which is used to indicate a Container service that is not also a ContainerManager.
CONTAINER_PROFILE - Static variable in interface net.openwings.container.ContainerAttributeConstants
This constant is the name of an attribute which is used to indicate the profile of a Container service.
CREATED - Static variable in class net.openwings.container.ContainerProcessStatus
This constant represents the initial state of a process before it is started.
Component - interface net.openwings.component.Component.
This interface is the centerpiece of the service-based component architecture provided by Openwings.
ComponentComplex - interface net.openwings.component.ComponentComplex.
This interface extends the Component interface to provide additional service-based functionality to the Openwings architecture.
ComponentDescriptor - class net.openwings.identity.ComponentDescriptor.
This class contains all of the information that would be used to identify and execute a component.
ComponentDescriptor() - Constructor for class net.openwings.identity.ComponentDescriptor
Default constructor
ComponentDescriptor(ComponentDescriptor) - Constructor for class net.openwings.identity.ComponentDescriptor
This is a shallow copy contructor.
ComponentDescriptor(UniqueID, String, String, String, boolean, String, String, boolean, boolean, boolean, boolean, boolean, URL[], URL[], Properties, String) - Constructor for class net.openwings.identity.ComponentDescriptor
This constructor is used to create an executable Java ComponentDescriptor.
ComponentDescriptor(UniqueID, String, String, String, boolean, String, String, boolean, boolean, boolean, String) - Constructor for class net.openwings.identity.ComponentDescriptor
This constructor is used to create a non-Java executable component descriptor.
ComponentDescriptor(UniqueID, String, String, String, String, URL[], URL[]) - Constructor for class net.openwings.identity.ComponentDescriptor
This constructor is used to create a non-executable Java component descriptor.
ComponentFactory - class net.openwings.component.ComponentFactory.
This class provides a way to obtain an implementation of Component or one of its subinterfaces.
ComponentFactory() - Constructor for class net.openwings.component.ComponentFactory
 
ComponentMBean - interface net.openwings.component.utilities.ComponentMBean.
This interface describes a management bean that can be used to access information about a component: Services used, provided, published, subscribed UIs associated with a service.
ComponentPolicy - interface net.openwings.component.ComponentPolicy.
This interface defines a policy which describes identity-related parameters of a component.
ConnectionListener - interface net.openwings.connector.synchronous.ConnectionListener.
This interface describes a callback for when a UserProxy connects or disconnects to or from a ProviderProxy.
Connector - class net.openwings.connector.Connector.
This class holds the ReceiverProxy and SenderProxy that make up an Openwings connector.
Connector() - Constructor for class net.openwings.connector.Connector
This default constructor calls the loadProxies() method.
Connector(ProtocolAttributes) - Constructor for class net.openwings.connector.Connector
This constructor sets protocol-specific attributes and then calls the loadProxies() method.
ConnectorClassArchiver - interface net.openwings.connector.ConnectorClassArchiver.
This interface describes a tool that is used to archive a compiled connector.
ConnectorCompilerExceptions - exception net.openwings.connector.ConnectorCompilerExceptions.
This class is used to collect various exceptions raised by a ConnectorGenerator.
ConnectorCompilerExceptions() - Constructor for class net.openwings.connector.ConnectorCompilerExceptions
This default constructor creates an empty collection of exceptions raised.
ConnectorGeneratorExceptions - exception net.openwings.connector.ConnectorGeneratorExceptions.
This exception is used to collect various exceptions raised while generating a connector.
ConnectorGeneratorExceptions() - Constructor for class net.openwings.connector.ConnectorGeneratorExceptions
This default constructor creates an empty collection of exceptions raised.
ConnectorLoader - interface net.openwings.connector.ConnectorLoader.
This interface describes a utility that loads asynchronous and synchronous connectors.
ConnectorLoaderFactory - class net.openwings.connector.ConnectorLoaderFactory.
This class provides a way to obtain an implementation of ConnectorLoader.
ConnectorRepository - interface net.openwings.connector.utilities.ConnectorRepository.
This interface specifies a service that generates and stores connectors.
ConnectorSourceCompiler - interface net.openwings.connector.ConnectorSourceCompiler.
This interface describes a tool that is used to compile the source of a generated connector
ConnectorSourceGenerator - interface net.openwings.connector.ConnectorSourceGenerator.
This interface describes a tool that is used to generate source files for the connector that can be used for a given interface.
Container - interface net.openwings.container.Container.
This interface provides the key abstraction for Container Services.
ContainerAccess - interface net.openwings.container.ContainerAccess.
This interface is provided by the Container implementation.
ContainerAccessFactory - class net.openwings.container.ContainerAccessFactory.
This class provides processes that are running in a Container a way to obtain an implementation of ContainerAccess.
ContainerAttributeConstants - interface net.openwings.container.ContainerAttributeConstants.
This interface provides descriptions of standard attributes that should be used in publishing Container and ContainerManager services.
ContainerListener - interface net.openwings.container.ContainerListener.
This interface describes a callback that can be used to register interest in receiving status updates from a Container or ContainerManager.
ContainerManager - interface net.openwings.container.ContainerManager.
This interface provides the external interface by which the computing resources of a platform can be accessed.
ContainerManagerListener - interface net.openwings.container.ContainerManagerListener.
This interface describes a callback that can be used to register interest in receiving status updates from a ContainerManager.
ContainerManagerMBean - interface net.openwings.container.ContainerManagerMBean.
This class is a management bean that a Container Manager implementation can expose to allow access to the set of processes it knows how to run.
ContainerManagerPolicy - interface net.openwings.container.utilities.ContainerManagerPolicy.
This interface defines a policy that a ContainerManager may use to persist information about the plugins it uses.
ContainerProcess - interface net.openwings.container.ContainerProcess.
This interface represents a single execution of a process running inside a Container or ContainerManager.
ContainerProcessListener - interface net.openwings.container.ContainerProcessListener.
This interface describes a callback that can be used to register interest in receiving process status updates from a ContainerProcess, Container, or ContainerManager.
ContainerProcessStatus - class net.openwings.container.ContainerProcessStatus.
This class describes the status of a running ContainerProcess.
ContainerProcessStatus(UniqueID, int, Date, Date, Date, UniqueID, int, int, Throwable, PerformanceReport[], boolean, boolean, boolean, String) - Constructor for class net.openwings.container.ContainerProcessStatus
This is the single public constructor for the ContainerProcessStatus class.
Context - interface net.openwings.context.Context.
This interface provides the key abstraction for Context Services.
ContextDescriptor - class net.openwings.context.ContextDescriptor.
This class defines the information that makes up a context descriptor.
ContextDescriptor() - Constructor for class net.openwings.context.ContextDescriptor
Default constructor
ContextDescriptor(UniqueID, String) - Constructor for class net.openwings.context.ContextDescriptor
This constructor sets the value of the relationship desciptor.
cloneComponentDescriptor(InstallableComponentDescriptor, String) - Method in interface net.openwings.install.InstallerMBean
This method is used to create alternate configurations of component descriptors in the Installer, so the same component may be run with different configurations.
compareSignedRoles(SignedObject, SignedObject) - Method in interface net.openwings.security.RoleSigner
This compares the credentials of two roles for equality.
compileConnector(String, String, String, String) - Method in interface net.openwings.connector.ConnectorSourceCompiler
This method compiles all of the classes needed by a connector that was previously generated.
compileConnector(String, String, String) - Method in interface net.openwings.connector.ConnectorSourceCompiler
This method compiles all of the classes needed by a connector that was previously generated.
compileConnector(String, String) - Method in interface net.openwings.connector.ConnectorSourceCompiler
This method compiles all of the classes needed by a connector that was previously generated.
componentUpdated(InstallableComponentDescriptor[]) - Method in interface net.openwings.install.InstallListener
The Installer implementation invokes this method any time a component's resolution state changes.
connect() - Method in interface net.openwings.connector.ReceiverProxy
This method connects the ReceiverProxy to the network.
connect() - Method in interface net.openwings.connector.SenderProxy
This method connects the SenderProxy to the ReceiverProxy over the network.
connectDistributedObject(Object) - Method in interface net.openwings.component.Component
This method can be used on the client side of a connection to enable a distributed object to be used.
createArchives(String, String) - Method in interface net.openwings.connector.ConnectorClassArchiver
This method creates the archive by the given archiveName based on the given interfaceName.
createArchives(String, String, String) - Method in interface net.openwings.connector.ConnectorClassArchiver
This method creates the archive by the given archiveName based on the given interfaceName.
createNewPolicy(Class) - Method in interface net.openwings.policy.PolicyLoader
Create a new policy object that implements the interface specified by the policyType parameter.
createProcess(ComponentDescriptor) - Method in interface net.openwings.container.Container
This method creates a process inside the container based on the given ComponentDescriptor.
createProcess(ComponentDescriptor, UniqueID, ContainerProcessStatus, MarshalledObject) - Method in interface net.openwings.container.Container
This method creates a process inside the container based on the given ComponentDescriptor, the process unique ID, and the saved process state.
createProcess(ComponentDescriptor, boolean, boolean, String) - Method in interface net.openwings.container.Container
This method creates a process inside the container based on the given ComponentDescriptor and lifecycle-related parameters.
createProcess(UniqueID) - Method in interface net.openwings.container.ContainerManager
This method creates a process inside the container manager based on the unique identifier of a ComponentDescriptor returned from getRunnableProcesses.
createProcess(UniqueID, boolean, boolean, boolean, String) - Method in interface net.openwings.container.ContainerManager
This method creates a process inside the container manager based on the unique identifier of a ComponentDescriptor returned from getRunnableProcesses.

D

DATA_DIR - Static variable in class net.openwings.install.InstallableComponentDescriptor
This is the name of a property used to reference the file URL location of a component's data directory.
DEFAULT_PROPERTY_FILE - Static variable in class net.openwings.identity.PropertyInitializer
This constant denotes the default property file name.
DEFAULT_TIMEOUT - Static variable in interface net.openwings.availability.Reachable
 
DEGRADED - Static variable in class net.openwings.availability.UnitReport
This constant is used to indicate that a unit has reduced performance.
DISK - Static variable in interface net.openwings.container.utilities.PlatformPerformance
The name of PerformanceReports for disk usage
DOCS_DIR - Static variable in class net.openwings.install.InstallableComponentDescriptor
This is the name of a property used to reference the file URL location of a component's documentation directory.
deleteRelationship(String) - Method in interface net.openwings.security.SecurityService
This method is used to remove a trust relationship between two platforms.
deleteRole(String) - Method in interface net.openwings.security.SecurityService
This method deletes the specified role from the system.
deleteUser(String) - Method in interface net.openwings.security.SecurityService
This method removes the user from the system.
deleteUserFromRole(String, String) - Method in interface net.openwings.security.SecurityService
This method removes the assignment of the role to the user.
denominator - Variable in class net.openwings.availability.PerformanceReport
This is the acutal available resources.
discardUsedService(UniqueID) - Method in interface net.openwings.component.Component
This method releases a synchronous (remote method) service provided by another component.
disconnect() - Method in interface net.openwings.connector.ReceiverProxy
This method disconnects the ReceiverProxy from the network.
disconnect() - Method in interface net.openwings.connector.SenderProxy
This method disconnects the SenderProxy from the ReceiverProxy.
disconnectDistributedObject(Object) - Method in interface net.openwings.component.Component
This method can be used on the client side of a connection to disable the connection of a distributed object.
distributeObject(Class, Object) - Method in interface net.openwings.component.Component
This method is used to make an object available remotely.
distributeObject(Class, Object, Class) - Method in interface net.openwings.component.Component
This method is used to make an object available remotely.

E

EventServiceListener - interface net.openwings.component.EventServiceListener.
This interface defines a callback which can be passed to publishService() / subscribeService() methods of the Component interface to register ongoing interest in certain asynchronous services (topics).
EventServiceParameters - class net.openwings.component.EventServiceParameters.
This class defines an object which can be passed to the publishService()/subscribeService() methods of the ComponentComplex interface to interface to specify configuration information and behavior relevant to using asynchronous (event or messaging) services (topics).
EventServiceParameters() - Constructor for class net.openwings.component.EventServiceParameters
Default constructor
EventServiceParameters(UniqueID, UniqueID, boolean, boolean, Class, Object[], boolean, Attribute[]) - Constructor for class net.openwings.component.EventServiceParameters
General constructor
EventServicePolicy - interface net.openwings.component.EventServicePolicy.
This interface defines a policy which can be used to persist a EventServiceParameters() object that is intended to be passed to one of the ComponentComplex.publishService() /subscribeService() methods to specify configuration information and behavior relevant to publishing/subscribing to a service.
equals(Object) - Method in class net.openwings.availability.PerformanceReport
overrides the default equals() method
equals(Object) - Method in class net.openwings.availability.UnitReport
overrides the default equals() method
equals(Object) - Method in class net.openwings.component.utilities.ServiceDescriptor
overrides default equals() method.
equals(Object) - Method in class net.openwings.container.ContainerProcessStatus
overrides default equals() method
equals(Object) - Method in class net.openwings.context.ContextDescriptor
overrides default equals() method.
equals(Object) - Method in class net.openwings.context.PlatformDescriptor
overrides default equals() method.
equals(Object) - Method in class net.openwings.identity.Attribute
This method overrides the default equals() implementation.
equals(Object) - Method in class net.openwings.identity.ComponentDescriptor
This method overrides the default equals() implementation.
equals(Object) - Method in class net.openwings.identity.UniqueID
Overrides the default implementation from Object.
equals(Object) - Method in class net.openwings.security.OpenwingsRole
This method overrides the default equals() implementation.
equalsStrict(ComponentDescriptor) - Method in class net.openwings.identity.ComponentDescriptor
This method provides a strict comparison with another ComponentDescriptor.
exception - Variable in class net.openwings.container.ProcessCreationException
 
exception - Variable in class net.openwings.install.InstallException
 

F

FAILED - Static variable in class net.openwings.container.ContainerProcessStatus
This constant represents a transitory state for a process that has terminated abnormally.
FILE_INCLUDE - Static variable in class net.openwings.identity.PropertyInitializer
This constant denotes a file inclusion

G

GREEN - Static variable in class net.openwings.availability.PerformanceReport
This constant is used to indicate normal performance levels.
generateConnector(Class, String, String) - Method in interface net.openwings.connector.ConnectorSourceGenerator
The proxies for the interfaces given to the constructor will be created and saved in the outputDirectory provided.
generatePolicy(String) - Method in interface net.openwings.policy.PolicyGenerator
Generate policy source code and configuration data files using the information from the specified interface.
getAcceptDistributedObjectsImmediately() - Method in class net.openwings.component.UseServiceParameters
This method returns a flag indicating whether a service (or services) should be connected immediately.
getAdapterURL() - Method in interface net.openwings.management.MBeanAdapter
This method is used to obtain a URL which can be used to access the adapted MBeans.
getAdapterURLList() - Method in interface net.openwings.management.RemoteManager
This method is used to obtain a set of URLs which can be used to access adapted MBeans (i.e.
getAllMBeans() - Method in interface net.openwings.management.RemoteManager
This method returns all MBeans registered with the Manager.
getBinDirectory() - Method in class net.openwings.install.InstallableComponentDescriptor
This method returns the relative location of the bin directory within the installable image jar file.
getBootProcessHint() - Method in class net.openwings.identity.ComponentDescriptor
This method returns true if the component should be started on platform boot.
getBuildUIImmediately() - Method in class net.openwings.component.EventServiceParameters
This method returns a flag that indicates whether the user interface for a used service should built immediately upon locating the service.
getBuildUIImmediately() - Method in class net.openwings.component.UseServiceParameters
This method returns a flag that indicates whether the user interface for a used service should built immediately upon locating the service.
getBytes() - Method in class net.openwings.identity.UniqueID
This method is provided as a convenience for conversion between different types of identifiers used in various frameworks.
getCertificate(String) - Method in interface net.openwings.security.SecurityService
This method is used to obtain the certificate associated with a particular user/role.
getCertificateChain(String) - Method in interface net.openwings.security.SecurityService
This method is used to obtain the certificate chain associated with a particular user/role.
getClasspath() - Method in class net.openwings.identity.ComponentDescriptor
This method returns the classpath of the component.
getCluster() - Method in interface net.openwings.context.Context
This method returns the cluster descriptor of the context cluster.
getClustered() - Method in class net.openwings.context.PlatformDescriptor
This method is used to find out if the platform is part of the context cluster.
getCodebase() - Method in class net.openwings.identity.ComponentDescriptor
This method returns the codebase of the component.
getCommandLineParameters() - Method in class net.openwings.container.ContainerProcessStatus
This method returns the command line parameters used to start the process.
getCommandLineParameters() - Method in class net.openwings.identity.ComponentDescriptor
This method returns the command line parameters that should be passed to the component on startup.
getComment() - Method in class net.openwings.component.ProvideServiceParameters
This method returns a note that describes some aspect of the service
getComment() - Method in class net.openwings.component.PublishServiceParameters
This method returns a note that describes some aspect of the service
getComponent() - Static method in class net.openwings.component.ComponentFactory
This method is used to obtain a Component.
getComponentComplex() - Static method in class net.openwings.component.ComponentFactory
This method is used to obtain a ComponentComplex.
getComponentDescriptor() - Method in interface net.openwings.component.Component
This method is used to retrieve metadata about a component
getComponentDescriptor() - Method in interface net.openwings.component.ComponentPolicy
 
getComponentDescriptor() - Method in interface net.openwings.container.ContainerProcess
This method returns the ComponentDescriptor object that was used to create this ContainerProcess.
getComponentDescriptor() - Method in interface net.openwings.install.InstallableComponentDescriptorPolicy
This method retrieves the component descriptor stored in the policy
getComponentID() - Method in interface net.openwings.component.Component
This method is used to retrieve a unique identifier for the component.
getComponentID() - Method in class net.openwings.component.EventServiceParameters
This method returns the unique identifier for a component.
getComponentID() - Method in class net.openwings.component.ServiceResult
This method returns the global unique service identifier for the component that provided this synchronous service / created this asynchronous service (topic), if known.
getComponentID() - Method in class net.openwings.component.UseServiceParameters
This method returns the unique identifier for a component.
getComponentName() - Method in class net.openwings.container.utilities.LogAccess.LogFileDescriptor
This method returns the name of the component.
getComponentName() - Method in class net.openwings.identity.ComponentDescriptor
This method returns the name of this component.
getComponents() - Method in interface net.openwings.install.Installer
This method returns an array of ComponentDescriptor for all components installed on the system.
getComponents() - Method in interface net.openwings.install.InstallerMBean
This method returns an array of ComponentDescriptor for all components installed on the system.
getConnector(Class, Class) - Method in interface net.openwings.connector.ConnectorLoader
This method instantiates and returns a connector for the given interface.
getConnector(Class, Class, ClassLoader) - Method in interface net.openwings.connector.ConnectorLoader
This method attempts to use the given ClassLoader to instantiate a connector for the given interface.
getConnector(Class, Class) - Method in interface net.openwings.connector.utilities.ConnectorRepository
This method returns a connector for the given interface (the choice of protocol is left to the ConnectorRepository implementation).
getConnectorLoader() - Static method in class net.openwings.connector.ConnectorLoaderFactory
This method is used to obtain a ConnectorLoader.
getContainerAccess() - Method in interface net.openwings.component.ComponentComplex
This method is used to obtain access to the Container in which this component is running.
getContainerAccess() - Static method in class net.openwings.container.ContainerAccessFactory
This method is used to obtain a ContainerAccess.
getContainerID() - Method in interface net.openwings.container.ContainerAccess
This method is used by a process (an Openwings Component or other Java program) to obtain the unique identifier of the container in which it is running.
getContainerID() - Method in class net.openwings.container.ContainerProcessStatus
This method returns a unique identifier representing the Container in which this ContainerProcess is running
getContainerID() - Method in class net.openwings.container.utilities.LoadBalancerContainerInfo
This method returns the unique identifier for the container.
getContainerProcessStatus() - Method in interface net.openwings.container.ContainerProcess
This method returns a ContainerProcessStatus object that represents the status of the ContainerProcess.
getContext() - Method in class net.openwings.context.ContextDescriptor
This method returns the unique id of the context.
getContext() - Method in interface net.openwings.security.SecurityService
This method is used to tell what context a platform is a member of.
getDataDirectory() - Method in class net.openwings.install.InstallableComponentDescriptor
This method returns the relative location of the data directory within the installable image jar file.
getDegraded() - Method in class net.openwings.availability.UnitReport
This method is used to get the degraded status.
getDenominator() - Method in class net.openwings.availability.PerformanceReport
This method is used to get the denominator of the measurement.
getDescription() - Method in class net.openwings.availability.UnitReport
This method is used to get the desription of the fault.
getDescription() - Method in class net.openwings.identity.ComponentDescriptor
This method returns a description of the component.
getDescription() - Method in interface net.openwings.policy.Policy
Get the human-readable description for this Policy.
getDesiredUIClass() - Method in class net.openwings.component.EventServiceParameters
This method returns the desired type of user interface for a service, based on the class of the UI object.
getDesiredUIClass() - Method in class net.openwings.component.UseServiceParameters
This method returns the desired type of user interface for a service, based on the class of the UI object.
getDesiredUIConstructorParameters() - Method in class net.openwings.component.EventServiceParameters
This method returns parameters that a UI factory will pass to the constructor of a UI object.
getDesiredUIConstructorParameters() - Method in class net.openwings.component.UseServiceParameters
This method returns parameters that a UI factory will pass to the constructor of a UI object.
getDisplayName() - Method in class net.openwings.component.ProvideServiceParameters
This method returns a name for the service which is intended for users to read, perhaps in a service browser or web browser
getDisplayName() - Method in class net.openwings.component.PublishServiceParameters
This method returns a name for the service which is intended for users to read, perhaps in a service browser or web browser
getDocsDirectory() - Method in class net.openwings.install.InstallableComponentDescriptor
This method returns the relative location of the docs directory within the installable image jar file.
getEmbeddedException() - Method in class net.openwings.policy.PolicyException
Get the Exception that triggered this exception.
getEmbeddedException() - Method in class net.openwings.ui.UserInterfaceException
Get the Exception that triggered this exception.
getException() - Method in class net.openwings.container.ProcessCreationException
this method returns the original exception thrown, or null.
getException() - Method in class net.openwings.install.InstallException
getException returns the original exception thrown.
getExceptionCount() - Method in class net.openwings.connector.ConnectorCompilerExceptions
This method returns the number of exceptions in this collection
getExceptionCount() - Method in class net.openwings.connector.ConnectorGeneratorExceptions
This method returns the number of exceptions in this collection
getExecutable() - Method in class net.openwings.identity.ComponentDescriptor
This method returns true if the component is executable.
getExecutableString() - Method in class net.openwings.identity.ComponentDescriptor
This method returns the command used to execute the component.
getHost() - Method in interface net.openwings.container.Container
This method returns the host on which this Container is running.
getHost() - Static method in class net.openwings.identity.PropertyInitializer
This method is a convenience function for getting the hostname in a property file.
getHost() - Method in interface net.openwings.security.SecurityService
This method returns the host on which this SecurityService is running.
getHttpDirectory() - Method in class net.openwings.install.InstallableComponentDescriptor
This method returns the relative location of the http directory within the installable image jar file.
getID() - Method in interface net.openwings.container.Container
This method returns a unique identifier for this Container.
getID() - Method in interface net.openwings.context.Context
This method is returns the unique identifier for the context.
getIconFile() - Method in class net.openwings.install.InstallableComponentDescriptor
This method returns the relative location of the icon file for this component within the installable image jar file.
getIconResource() - Method in class net.openwings.component.ProvideServiceParameters
This method returns the name of a resource that is an icon that can be used to depict this service.
getIconResource() - Method in class net.openwings.component.PublishServiceParameters
This method returns the name of a resource that is an icon that can be used to depict this service.
getImplementsInterface() - Method in class net.openwings.component.utilities.ServiceDescriptor
This method tells whether this service is implemented locally or remotely.
getInetAddress() - Method in interface net.openwings.management.RemoteManager
This method returns the host on which the Manager is running.
getInstallJarURLs(UniqueID) - Method in interface net.openwings.install.InstallerMBean
This method is used to retrieve a list of URLs that represent download locations for all dependencies of this component, including the component itself.
getInstallState() - Method in class net.openwings.install.InstallableComponentDescriptor
This method returns the state of this component: UNINSTALLED, AUTHENTICATED, INSTALLED, or RESOLVED.
getLastExitCode() - Method in class net.openwings.container.ContainerProcessStatus
This method returns the result of the last execution of the ContainerProcess
getLastFailureCause() - Method in class net.openwings.container.ContainerProcessStatus
This method returns the exception or error that caused the ContainerProcess to fail
getLastLoadURL() - Method in interface net.openwings.policy.Policy
Returns a URL corresponding to the last location from which the policy was loaded.
getLastModified() - Method in class net.openwings.container.utilities.LogAccess.LogFileDescriptor
This method returns the log file modification time.
getLibDirectory() - Method in class net.openwings.install.InstallableComponentDescriptor
This method returns the relative location of the lib directory within the installable image jar file.
getLoadBalancerImplementation() - Method in interface net.openwings.container.utilities.ContainerManagerPolicy
This method gets the name of the class containing the implementation of the LoadBalancer implementation
getLoadBalancerProcessInfoList() - Method in class net.openwings.container.utilities.LoadBalancerContainerInfo
This method returns information about the mobile processes in the container.
getLogFileDescriptors() - Method in interface net.openwings.container.utilities.LogAccess
This method is used to obtain the list of log files on a system
getMBean(Class) - Method in interface net.openwings.management.RemoteManager
This method will return all MBeans of the requested type that are registered with the Manager.
getMBeanAdapterClasses() - Method in interface net.openwings.management.ManagementPolicy
This method returns the MBeanAdapters to be used by the Manager
getMBeanClasses() - Method in interface net.openwings.management.ManagementPolicy
This method returns the default MBeans to be created by the Manager
getMBeanInfo() - Method in interface net.openwings.management.MBean
This method provides information about the bean including the name and description.
getManager() - Method in interface net.openwings.component.ComponentComplex
This method is used to obtain a management context that the component can use to instantiate management plug-ins (MBeans).
getManager() - Static method in class net.openwings.management.ManagerFactory
This method is used to obtain a Manager.
getMaximumNumberOfResults() - Method in class net.openwings.component.UseServiceParameters
This method returns an integer that represents an upper limit on the number of ServiceResult objects that should be returned from a call to ComponentComplex.useService().
getMessage() - Method in class net.openwings.connector.ConnectorCompilerExceptions
This method creates and returns a single string representation of how the messages of all of the exceptions within the collection would have looked if they had been allowed to be thrown up the stack.
getMessage() - Method in class net.openwings.connector.ConnectorGeneratorExceptions
This method creates and returns a single string representation of how the messages of all of the exceptions within the collection would have looked if they had been allowed to be thrown up the stack.
getMessage() - Method in class net.openwings.policy.PolicyException
Returns the error message string of this throwable object.
getMessage() - Method in class net.openwings.ui.UserInterfaceException
Returns the error message string of this throwable object.
getMobile() - Method in class net.openwings.container.ContainerProcessStatus
This method indicates whether this process may be moved between containers or platforms.
getMobile() - Method in class net.openwings.identity.ComponentDescriptor
This method returns true if the component can move between containers or platforms.
getName() - Method in class net.openwings.availability.PerformanceReport
This method is used to get the name of the performance metric.
getName() - Method in class net.openwings.availability.UnitReport
This method is used to get the name of the unit under test.
getName() - Method in class net.openwings.component.utilities.ServiceDescriptor
This method returns the name of the service.
getName() - Method in class net.openwings.component.utilities.UserInterfaceDescriptor
This method returns the name of the user interface.
getName() - Method in interface net.openwings.context.Context
This method is returns the name of the context.
getName() - Method in class net.openwings.context.ContextDescriptor
This method returns the name of the context.
getName() - Method in class net.openwings.context.PlatformDescriptor
This method returns the name of the platform.
getName() - Method in class net.openwings.identity.Attribute
This method returns the name / key for the attribute
getName() - Method in interface net.openwings.policy.Policy
Get the name of this Policy.
getName() - Method in class net.openwings.security.OpenwingsRole
This method returns the name of the role.
getNewContainerID() - Method in class net.openwings.container.utilities.LoadBalancerAssignment
This method returns the unique identifier for the new container.
getNumerator() - Method in class net.openwings.availability.PerformanceReport
This method is used to get the numerator of the measurement.
getOldContainerID() - Method in class net.openwings.container.utilities.LoadBalancerAssignment
This method returns the unique identifier for the old container.
getParameters() - Method in interface net.openwings.component.EventServicePolicy
This method returns the parameters for publishing/subscribing to some service.
getParameters() - Method in interface net.openwings.component.ProvideServicePolicy
This method returns the parameters for using some service.
getParameters() - Method in interface net.openwings.component.PublishServicePolicy
This method returns the parameters for creating an asynchronous service (topic).
getParameters() - Method in interface net.openwings.component.UseServicePolicy
This method returns the parameters for using some service.
getPercentUsage() - Method in class net.openwings.availability.PerformanceReport
This method is used to get the percentage utilization of this metric.
getPerformanceReports() - Method in interface net.openwings.container.Container
This method is used to obtain performance reports for the container.
getPerformanceReports() - Method in class net.openwings.container.ContainerProcessStatus
This method returns
getPerformanceReports() - Method in class net.openwings.container.utilities.LoadBalancerContainerInfo
This method returns the performance reports for the container.
getPerformanceReports() - Method in class net.openwings.container.utilities.LoadBalancerProcessInfo
This method returns the performance reports for the process.
getPerformanceReports() - Method in interface net.openwings.container.utilities.PlatformPerformance
This method returns the current set of performance reports for this platform.
getPerformanceThresholds() - Method in interface net.openwings.container.utilities.ContainerManagerPolicy
This method gets the thresholds that determine the GREEN/YELLOW/RED designation for a particular type of PerformanceReport
getPlatform() - Method in class net.openwings.context.PlatformDescriptor
This method returns the unique id of the platform.
getPlatform() - Method in class net.openwings.identity.ComponentDescriptor
This method returns the platform on which this component can run.
getPlatformPerformanceImplementation() - Method in interface net.openwings.container.utilities.ContainerManagerPolicy
This method gets the name of the class containing the implementation of the PlatformPerformance implementation
getPlatforms() - Method in interface net.openwings.context.Context
This method is used to get all of the platforms for the context.
getPolicies() - Method in interface net.openwings.context.Context
This method is used to get all of the policies for the context
getPolicy(String) - Method in interface net.openwings.context.Context
This method is used to get a policy from the context.
getPolicy(Class, URL) - Method in interface net.openwings.policy.PolicyLoader
Get a policy object that implements the interface specified by the policyType parameter.
getPolicy(Class, File) - Method in interface net.openwings.policy.PolicyLoader
Get a policy object that implements the interface specified by the policyType parameter.
getPolicy(Class, String) - Method in interface net.openwings.policy.PolicyLoader
Get a policy object that implements the interface specified by the policyType parameter.
getPolicy(Class, String, ClassLoader) - Method in interface net.openwings.policy.PolicyLoader
Get a policy object that implements the interface specified by the policyType parameter.
getPolicyAttributes() - Method in interface net.openwings.policy.Policy
Returns an array of strings that contains the attributes for the policy in the order defined in the schema.
getPolicyDirectory() - Method in class net.openwings.install.InstallableComponentDescriptor
This method returns the relative location of the policies directory within the installable image jar file.
getPolicyElements() - Method in interface net.openwings.policy.Policy
Returns an array of strings that contains the elements for the policy in the order defined in the schema.
getPolicyKeys() - Method in interface net.openwings.context.Context
This method is used to get all of the policy keys for the context.
getPolicyLoader() - Method in interface net.openwings.component.ComponentComplex
This method is used to obtain a PolicyLoader that the component can use to instantiate policies.
getPolicyLoader() - Static method in class net.openwings.policy.PolicyLoaderFactory
This method is used to obtain a PolicyLoader.
getProcessID() - Method in interface net.openwings.container.ContainerAccess
This method is used by a process (an Openwings Component or other Java program) to obtain its own unique process identifier from the container in which it is running.
getProcessID() - Method in interface net.openwings.container.ContainerProcess
This method returns the unique identifier for this process.
getProcessID() - Method in class net.openwings.container.ContainerProcessStatus
This method returns the unique identifier for the ContainerProcess
getProcessID() - Method in class net.openwings.container.utilities.LoadBalancerAssignment
This method returns the unique identifier for the process.
getProcessID() - Method in class net.openwings.container.utilities.LoadBalancerProcessInfo
This method returns the unique identifier for the process.
getProcessID() - Method in class net.openwings.container.utilities.LogAccess.LogFileDescriptor
This method returns the unique identifier for the process.
getProcessInputStream(String, UniqueID) - Method in interface net.openwings.container.utilities.LogAccess
This method is used to obtain an input stream for a given process
getProcessStartTime() - Method in class net.openwings.container.ContainerProcessStatus
This method returns the time that the ContainerProcess was started or restarted
getProcessState() - Method in interface net.openwings.container.MobileProcess
This method returns the latest serialized state of a MobileProcess.
getProcessState(boolean) - Method in interface net.openwings.container.ProcessAccess
This method is called by the container to pull the process state.
getProcessStatusTime() - Method in class net.openwings.container.ContainerProcessStatus
This method returns the time that this report was generated
getProcessStopTime() - Method in class net.openwings.container.ContainerProcessStatus
This method returns the time that the ContainerProcess failed or was stopped
getProcesses() - Method in interface net.openwings.container.Container
This method is used to access all of the processes that are currently running inside a container.
getProperties() - Method in interface net.openwings.context.Context
This method is used to get all of the properties for this context.
getProperties() - Method in class net.openwings.identity.ComponentDescriptor
This method returns the properties used by the component.
getProperty(String) - Method in interface net.openwings.context.Context
This method is used to get a property from the context.
getProtocolAttributes() - Method in class net.openwings.connector.Connector
This method returns the ProtocolAttributes of this connector.
getProtocolAttributesClass() - Static method in class net.openwings.connector.Connector
This method returns the type of ProtocolAttributes object used to instantiate this connector.
getProvidedServices() - Method in interface net.openwings.component.utilities.ComponentMBean
This method is used to get all of the services being provided by this component.
getProviderProxy() - Method in class net.openwings.connector.synchronous.SynchronousConnector
This method returns the receiverProxy of the superclass Connector as an instance of ProviderProxy
getPublishedServices() - Method in interface net.openwings.component.utilities.ComponentMBean
This method is used to get all of the services being published by this component.
getPublisherProxy() - Method in class net.openwings.connector.asynchronous.AsynchronousConnector
This method returns the senderProxy of the superclass Connector casted to a PublisherProxy.
getPublisherUIFactories() - Method in class net.openwings.component.PublishServiceParameters
This method returns the array of UserInterfaceFactory objects that will be provided along with the service for use by publishers
getReachable() - Static method in class net.openwings.availability.ReachableFactory
This method is used to obtain an implementation of the Reachable plugin.
getReceiverProxy() - Met