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() - Method in class net.openwings.connector.Connector
This method returns the ReceiverProxy of this connector.
getRedThreshold() - Method in class net.openwings.container.utilities.PerformanceThreshold
This method returns the threshold indicating imminent failure.
getRelationships() - Method in interface net.openwings.context.Context
This method returns the relationships this context currently has.
getReportName() - Method in class net.openwings.container.utilities.PerformanceThreshold
This method returns the name of the report.
getReportTypes() - Method in interface net.openwings.container.utilities.PlatformPerformance
This method returns the names of PerformanceReports generated by this object.
getRequiredAttribute(Attribute) - Method in class net.openwings.component.EventServiceParameters
This convenience method retrieves a service attribute
getRequiredAttribute(String) - Method in class net.openwings.component.EventServiceParameters
This convenience method retrieves a service attribute by name
getRequiredAttribute(Attribute) - Method in class net.openwings.component.UseServiceParameters
This convenience method retrieves a service attribute
getRequiredAttribute(String) - Method in class net.openwings.component.UseServiceParameters
This convenience method retrieves a service attribute by name
getRequiredAttributes() - Method in class net.openwings.component.EventServiceParameters
This method returns required attributes for service
getRequiredAttributes() - Method in class net.openwings.component.UseServiceParameters
This method returns required attributes for service
getResolvableClasspath() - Method in class net.openwings.install.InstallableComponentDescriptor
This method returns an array of strings used to build the classpath field of this descriptor.
getResolvableCodebase() - Method in class net.openwings.install.InstallableComponentDescriptor
This method returns an array of strings used to build the codebase field of this descriptor.
getResolvedDependencyComponents(UniqueID, boolean) - Method in interface net.openwings.install.InstallerMBean
This method is used to retrieve resolved dependencies of a component.
getRestart() - Method in class net.openwings.container.ContainerProcessStatus
This method indicates whether this process will be restarted if it fails.
getRestartHint() - Method in class net.openwings.identity.ComponentDescriptor
This method returns true if the component should be restarted in case of failure.
getReturnServiceAttributes() - Method in class net.openwings.component.EventServiceParameters
This method returns a flag that indicates whether the attributes of a used service should be returned in the serviceAttributes field of a ServiceResult (or ServiceResult).
getReturnServiceAttributes() - Method in class net.openwings.component.UseServiceParameters
This method returns a flag that indicates whether the attributes of a used service should be returned in the serviceAttributes field of a ServiceResult.
getReturnUserInterfaceFactories() - Method in class net.openwings.component.EventServiceParameters
This method returns a flag that indicates whether the user interface factories attached to a used service should be returned in the userInterfaceFactories field of a ServiceResult.
getReturnUserInterfaceFactories() - Method in class net.openwings.component.UseServiceParameters
This method returns a flag that indicates whether the user interface factories attached to a used service should be returned in the userInterfaceFactories field of a ServiceResult.
getRoleSigner() - Static method in class net.openwings.security.RoleSignerFactory
This method is used to obtain a RoleSigner.
getRoles(Subject) - Method in interface net.openwings.security.SecurityService
This method returns the list of OpenwingsRoles (Principals) assigned to a subject.
getRoles(String) - Method in interface net.openwings.security.SecurityService
This method returns the list of OpenwingsRoles (Principals) assigned to a user name.
getRunImmediatelyHint() - Method in class net.openwings.identity.ComponentDescriptor
This method returns true if the component should be started immediately.
getRunnableProcesses() - Method in interface net.openwings.container.ContainerManager
This method returns the current list of ComponentDescriptors that this ContainerManager is able to run.
getRunnableProcesses() - Method in interface net.openwings.container.ContainerManagerMBean
This method returns the deployment view of each process the ContainerManager is able to run
getSenderProxy() - Method in class net.openwings.connector.Connector
This method returns the SenderProxy of this connector.
getSerialNumber() - Method in class net.openwings.component.ProvideServiceParameters
This method returns the serial number of the service
getSerialNumber() - Method in class net.openwings.component.PublishServiceParameters
This method returns the serial number of the service
getServeHint() - Method in class net.openwings.install.InstallableComponentDescriptor
This method returns a flag that indicates whether this component should be served to other platforms (via a web server).
getService() - Method in class net.openwings.component.ServiceResult
This method returns the service object.
getServiceAttribute(Attribute) - Method in class net.openwings.component.ProvideServiceParameters
This convenience method retrieves a service attribute
getServiceAttribute(String) - Method in class net.openwings.component.ProvideServiceParameters
This convenience method retrieves a service attribute by name
getServiceAttribute(Attribute) - Method in class net.openwings.component.PublishServiceParameters
This convenience method retrieves a service attribute
getServiceAttribute(String) - Method in class net.openwings.component.PublishServiceParameters
This convenience method retrieves a service attribute by name
getServiceAttribute(String) - Method in class net.openwings.component.ServiceResult
This convenience method retrieves a service attribute by name.
getServiceAttributes() - Method in class net.openwings.component.ProvideServiceParameters
This method returns attributes that describe a service
getServiceAttributes() - Method in class net.openwings.component.PublishServiceParameters
This method returns attributes that describe a service
getServiceAttributes() - Method in class net.openwings.component.ServiceResult
This method returns attributes that describe a service, if requested
getServiceDescription() - Method in class net.openwings.component.ProvideServiceParameters
This method returns a longer textual description of the service
getServiceDescription() - Method in class net.openwings.component.PublishServiceParameters
This method returns a longer textual description of the service
getServiceID() - Method in class net.openwings.component.EventServiceParameters
This method returns the unique identifier for a service.
getServiceID() - Method in class net.openwings.component.ProvideServiceParameters
This method returns the unique identifier that should be used to identify the service when it is provided
getServiceID() - Method in class net.openwings.component.PublishServiceParameters
This method returns the unique identifier that should be used to identify the service when it is provided
getServiceID() - Method in class net.openwings.component.ServiceResult
This method returns the global unique service identifier for this service
getServiceID() - Method in class net.openwings.component.UseServiceParameters
This method returns the unique identifier for a service.
getServiceInterface() - Method in class net.openwings.component.utilities.ServiceDescriptor
This method returns the class of the service interface.
getServiceName() - Method in class net.openwings.component.ProvideServiceParameters
This method returns the name that will be used to describe the service
getServiceName() - Method in class net.openwings.component.PublishServiceParameters
This method returns the name that will be used to describe the service
getSharedContainer() - Method in class net.openwings.container.ContainerProcessStatus
This method indicates whether this process is running inside a container.
getSharedContainerHint() - Method in class net.openwings.identity.ComponentDescriptor
This method returns true if the component can share a container with other components.
getSignedObject(Serializable) - Method in interface net.openwings.security.SecurityService
This method is used to sign an object with the Openwings private key
getSignedRole(String) - Method in interface net.openwings.security.RoleSigner
This method constructs the signed object that represents the role's credentials.
getSourceDirectory() - Method in class net.openwings.install.InstallableComponentDescriptor
This method returns the relative location of the source directory within the installable image jar file.
getState() - Method in class net.openwings.availability.UnitReport
This method is used to get the state of this unit.
getStatus() - Method in class net.openwings.availability.PerformanceReport
This method is used to get the status of this performance metric.
getStatus() - Method in class net.openwings.availability.UnitReport
This method is used to get the status of this unit.
getStatus() - Method in class net.openwings.container.ContainerProcessStatus
This method returns the execution status of the process
getStatusOfAllProcesses() - Method in interface net.openwings.container.Container
This method is a convenience method that reports the status of all of the processes that are currently running inside a container.
getSubscribedServices() - Method in interface net.openwings.component.utilities.ComponentMBean
This method is used to get all of the services being subscribed by this component.
getSubscriberProxy() - Method in class net.openwings.connector.asynchronous.AsynchronousConnector
This method returns the receiverProxy of the superclass Connector casted to a SubscriberProxy
getSubscriberUIFactories() - 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 subscribers
getSupportedServiceInterface() - Method in class net.openwings.component.utilities.UserInterfaceDescriptor
This method returns the service interface supported by the user interface
getSupportedServiceInterfaces() - Method in interface net.openwings.ui.UserInterfaceFactory
This method is used to obtain the service interfaces for which this factory can build user interfaces.
getSupportedUIClass() - Method in class net.openwings.component.utilities.UserInterfaceDescriptor
This method returns the the Java type of the user interface.
getSupportedUIClasses() - Method in interface net.openwings.ui.UserInterfaceFactory
This method is used to get the desired type of user interface for a service, based on the class of the UI object.
getSystemRoles() - Method in interface net.openwings.security.SecurityService
This method returns the list of roles currently present in the system.
getTimeout() - Method in interface net.openwings.availability.Reachable
This method is used to get the timeout duration.
getTimesRestarted() - Method in class net.openwings.container.ContainerProcessStatus
This method returns the count of how many times the ContainerProcess has been restarted
getTimestamp() - Method in class net.openwings.availability.UnitReport
This method is used to get the date of this unit.
getUniqueID() - Method in class net.openwings.component.utilities.ServiceDescriptor
This method returns the unique identifier for the service.
getUniqueID() - Method in class net.openwings.identity.ComponentDescriptor
This method returns the unique identifer of this component.
getUniqueID() - Static method in class net.openwings.identity.UniqueIDFactory
This method is used to obtain a UniqueID.
getUniqueID() - Method in interface net.openwings.identity.UniqueIDGenerator
This method is used to obtain a UniqueID.
getUnits() - Method in class net.openwings.availability.PerformanceReport
This method is used to get the units of the performance metric.
getUnresolvedDependencyComponents(UniqueID, boolean) - Method in interface net.openwings.install.InstallerMBean
This method is used to retrieve unresolved dependencies of a component.
getUnsignedObject(SignedObject) - Method in interface net.openwings.security.SecurityService
This method is used to retrieve the contents of an object signed by the Openwings private key
getUsedServices() - Method in interface net.openwings.component.utilities.ComponentMBean
This method is used to get all of the services being used by this component.
getUserInterface(UniqueID) - Method in interface net.openwings.component.ComponentComplex
This method is used to obtain a User Interface for a given service object.
getUserInterface() - Method in class net.openwings.component.ServiceResult
This method returns the user interface object for this service, if one was requested.
getUserInterfaceBuilder() - Static method in class net.openwings.ui.UserInterfaceBuilderFactory
This method is used to obtain a UserInterfaceBuilder.
getUserInterfaceDescriptors(ServiceDescriptor) - Method in interface net.openwings.component.utilities.ComponentMBean
This method is used to get the UserInterfaces that were published with the service.
getUserInterfaceFactories() - Method in class net.openwings.component.ProvideServiceParameters
This method returns the array of UserInterfaceFactory objects that will be provided along with the service
getUserInterfaceFactories() - Method in class net.openwings.component.ServiceResult
This method returns acceptable user interface factories for this service, if requested.
getUserInterfaceFactories() - Method in interface net.openwings.management.ManagementPolicy
This method returns the UserInterfaceFactorys that correspond to the default MBeans
getUserInterfaceFactories(MBean) - Method in interface net.openwings.management.RemoteManager
This method is used to obtain user interface factories available that can build a user interface for a particular service interface.
getUserInterfaceFactories(MBean, Class[]) - Method in interface net.openwings.management.RemoteManager
This method is used to obtain user interface factories available that can build a user interface for a particular service interface.
getUserInterfaceFactories(Class) - Method in interface net.openwings.ui.UserInterfaceRepository
This method is used to obtain user interface factories available that can build a user interface for a particular service interface
getUserInterfaceFactories(Class, Class[]) - Method in interface net.openwings.ui.UserInterfaceRepository
This method is used to obtain user interface factories available that can build a user interface for a particular service interface The factory must be able to produce a user interface that is an instance of one of the specified Java types.
getUserProxy() - Method in class net.openwings.connector.synchronous.SynchronousConnector
This method returns the senderProxy of the superclass Connector as an instance of UserProxy
getUsers() - Method in interface net.openwings.security.SecurityService
This method returns the list of users currently present in the system.
getValue() - Method in class net.openwings.identity.Attribute
This method returns the value of the attribute
getVerificationKey() - Method in interface net.openwings.security.SecurityService
This method returns the SecurityService public key corresponding to the private key used to sign objects.
getVersion() - Method in class net.openwings.identity.ComponentDescriptor
This method returns the version number of this component.
getVisible(InetAddress) - Static method in class net.openwings.availability.VisibleFactory
This method is used to obtain an implementation of the Visible plugin based on an address.
getVisible(String) - Static method in class net.openwings.availability.VisibleFactory
This method is used to obtain an implementation of the Visible plugin based on a hostname.
getYellowThreshold() - Method in class net.openwings.container.utilities.PerformanceThreshold
This method returns the threshold indicating degraded operation.

H

HOST - Static variable in interface net.openwings.container.ContainerAttributeConstants
This constant is the name of an attribute which is the hostname of the machine on which a Container or ContainerManager is running.
HTTP - Static variable in class net.openwings.install.InstallableComponentDescriptor
This is the name of a property used to reference the http URL location of the root of a component's codebase.
HTTP_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 http directory.
HeartbeatListener - interface net.openwings.availability.HeartbeatListener.
This interface describes a listener that may be registered with the AvailabilityMBean to receive periodic heartbeat events.
hasCertificate(String) - Method in interface net.openwings.security.SecurityService
This method is used to determine if a user/role has a certificate in the keystore.
hasTrustedCertificate(String) - Method in interface net.openwings.security.SecurityService
This method is used to determine if a user/role has a trusted certificate in the keystore.
hashCode() - Method in class net.openwings.availability.PerformanceReport
overrides default hashCode() method.
hashCode() - Method in class net.openwings.availability.UnitReport
overrides default hashCode() method.
hashCode() - Method in class net.openwings.component.utilities.ServiceDescriptor
overrides default hashCode() method.
hashCode() - Method in class net.openwings.container.ContainerProcessStatus
overrides default hashCode() method
hashCode() - Method in class net.openwings.context.ContextDescriptor
overrides default hashCode() method.
hashCode() - Method in class net.openwings.context.PlatformDescriptor
overrides default hashCode() method.
hashCode() - Method in class net.openwings.identity.Attribute
overrides default hashCode() method.
hashCode() - Method in class net.openwings.identity.ComponentDescriptor
overrides default hashCode() method.
hashCode() - Method in class net.openwings.identity.UniqueID
Overrides the default implementation from Object.
hashCode() - Method in class net.openwings.security.OpenwingsRole
This method overrides the default hashCode() implementation.
heartbeat() - Method in interface net.openwings.availability.HeartbeatListener
This method is used to deliver the heartbeat.

I

ICON_URL - Static variable in class net.openwings.install.InstallableComponentDescriptor
This is the name of a property used to reference the http URL location of a component's icon file.
INITIALIZING - Static variable in class net.openwings.availability.UnitReport
This constant is used to indicate that a unit is initializing.
INSTALLED - Static variable in class net.openwings.install.InstallableComponentDescriptor
This is the state of a component which has been installed but still has unresolved dependencies.
INSTALL_FROM_URL - Static variable in class net.openwings.install.InstallableComponentDescriptor
This is the name of a property used to reference the http or file URL location of the original image jar from which a component was installed.
INSTALL_JAR_URL - Static variable in class net.openwings.install.InstallableComponentDescriptor
This is the name of a property used to reference the http URL location of a served component image.
INSTALL_STATIC - Static variable in class net.openwings.install.InstallableComponentDescriptor
This is the name of a property used to denote a static component
InstallException - exception net.openwings.install.InstallException.
This class is an exception which is used by classes in the Install API to indicate a problem with the addition or removal of a component.
InstallException(Exception) - Constructor for class net.openwings.install.InstallException
InstallException constructs a DataServerException with the corresponding exception.
InstallException(String) - Constructor for class net.openwings.install.InstallException
InstallException constructs an InstallException with the corresponding error message.
InstallListener - interface net.openwings.install.InstallListener.
This interface describes a callback that may be registered by components that wish to be notified of installation events.
InstallableComponentDescriptor - class net.openwings.install.InstallableComponentDescriptor.
This class extends ComponentDescriptor, adding all the information that would be used by the Install Service to install a component.
InstallableComponentDescriptor(InstallableComponentDescriptor) - Constructor for class net.openwings.install.InstallableComponentDescriptor
This copy constructor does a shallow copy, i.e.
InstallableComponentDescriptor(UniqueID, String, String, String, boolean, String, String, boolean, boolean, boolean, boolean, boolean, URL[], URL[], Properties, String, boolean, String, String, String, String, String, String, String, String, String[], String[], int) - Constructor for class net.openwings.install.InstallableComponentDescriptor
This constructor is used an executable java ComponentDescriptor
InstallableComponentDescriptor(UniqueID, String, String, String, boolean, String, String, boolean, boolean, boolean, String, boolean, String, String, String, String, String, String, String, String, String[], String[], int) - Constructor for class net.openwings.install.InstallableComponentDescriptor
This constructor is used to create a non-java executable component descriptor.
InstallableComponentDescriptor(UniqueID, String, String, String, String, URL[], URL[], boolean, String, String, String, String, String, String, String, String, String[], String[], int) - Constructor for class net.openwings.install.InstallableComponentDescriptor
This constructor is used to create a non-executable java component descriptor.
InstallableComponentDescriptor() - Constructor for class net.openwings.install.InstallableComponentDescriptor
Default Constructor
InstallableComponentDescriptorPolicy - interface net.openwings.install.InstallableComponentDescriptorPolicy.
This interface provides a policy that may be used to store an InstallableComponentDescriptor.
Installer - interface net.openwings.install.Installer.
This interface is the main interface for an Openwings Installer.
InstallerMBean - interface net.openwings.install.InstallerMBean.
This interface is a utility interface for a management bean that may optionally be provided by an Openwings Installer.
InvalidServiceException - exception net.openwings.component.InvalidServiceException.
This class is an exception that is thrown by methods in the Component Services API to indicate that a service object or interface is invalid.
InvalidServiceException(String) - Constructor for class net.openwings.component.InvalidServiceException
InvalidServiceException constructs a InvalidServiceException with the corresponding error message.
initialize() - Static method in class net.openwings.identity.PropertyInitializer
This method is used to set properties from a property file.
installComponent(URL, boolean) - Method in interface net.openwings.install.Installer
This method is used to add a Component to a platform.
installComponent(URL, boolean, boolean, boolean) - Method in interface net.openwings.install.Installer
This method is used to add a Component to a platform.
invisible(InetAddress) - Method in interface net.openwings.availability.VisibleListener
This method is called by Visible to notify the listener of a change in a connection's status from online to offline.
isPolicyUpdated() - Method in interface net.openwings.policy.Policy
Determines if this policy has been updated and is in need of being saved.
isReachable(String) - Method in interface net.openwings.availability.Reachable
This method is used to determine if an IP address is reachable.
isSigner(Certificate[]) - Method in interface net.openwings.security.SecurityService
This method is used to determine whether the signer of an application is a signer known but not necessarily trusted by the system.
isTrustedSigner(Certificate[]) - Method in interface net.openwings.security.SecurityService
This method is used to determine whether the signer of an application is a signer trusted by the system.

L

LIB_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 lib directory.
LOCAL - Static variable in class net.openwings.install.InstallableComponentDescriptor
This is the name of a property used to reference the absolute file location of an installed component (not a URL).
LOCAL_DIR - Static variable in class net.openwings.install.InstallableComponentDescriptor
This is the name of a property used to reference the file URL location of an installed component.
LoadBalancer - interface net.openwings.container.utilities.LoadBalancer.
This interface describes a plug-in that makes load balancing decisions for a container manager.
LoadBalancerAssignment - class net.openwings.container.utilities.LoadBalancerAssignment.
This class describes an assignment of a MobileProcess to a new container.
LoadBalancerAssignment() - Constructor for class net.openwings.container.utilities.LoadBalancerAssignment
Default Constructor.
LoadBalancerAssignment(UniqueID, UniqueID, UniqueID) - Constructor for class net.openwings.container.utilities.LoadBalancerAssignment
This is the primary public constructor for this class.
LoadBalancerContainerInfo - class net.openwings.container.utilities.LoadBalancerContainerInfo.
This class contains the information about a Container that a plug-in LoadBalancer uses to make load balancing decisions for a container manager.
LoadBalancerContainerInfo() - Constructor for class net.openwings.container.utilities.LoadBalancerContainerInfo
Default Constructor.
LoadBalancerContainerInfo(UniqueID, LoadBalancerProcessInfo[], PerformanceReport[]) - Constructor for class net.openwings.container.utilities.LoadBalancerContainerInfo
This is the single public constructor for this class.
LoadBalancerProcessInfo - class net.openwings.container.utilities.LoadBalancerProcessInfo.
This class contains the information about a MobileProcess that a plug-in LoadBalancer uses to make load balancing decisions for a container manager.
LoadBalancerProcessInfo() - Constructor for class net.openwings.container.utilities.LoadBalancerProcessInfo
Default Constructor
LoadBalancerProcessInfo(UniqueID, PerformanceReport[]) - Constructor for class net.openwings.container.utilities.LoadBalancerProcessInfo
This is the single public constructor for this class.
LogAccess - interface net.openwings.container.utilities.LogAccess.
This interface describes a service that can be used to obtain access to the log files for processes managed by a given container manager
LogAccess.LogFileDescriptor - class net.openwings.container.utilities.LogAccess.LogFileDescriptor.
This class describes a log file for an Openwings process.
LogAccess.LogFileDescriptor(String, UniqueID, long) - Constructor for class net.openwings.container.utilities.LogAccess.LogFileDescriptor
This is the single public constructor for this class.
list(PrintStream) - Method in class net.openwings.identity.ComponentDescriptor
Convenience method for printing out the contents of the descriptor
list(PrintStream) - Method in class net.openwings.install.InstallableComponentDescriptor
Convenience method for printing out the contents of the descriptor
loadPolicy(URL) - Method in interface net.openwings.policy.Policy
Load the policy with configuration data from the URL.
loadPolicy(File) - Method in interface net.openwings.policy.Policy
Load the policy with configuration data from the File.
loadProxies() - Method in class net.openwings.connector.Connector
This method populates the senderProxy and receiverProxy fields of this class.

M

MAX_DEPENDENCY_DEPTH - Static variable in class net.openwings.identity.PropertyInitializer
This constant represents the maximum number of references to follow when resolving dependencies.
MBean - interface net.openwings.management.MBean.
This is the top-level interface for management beans in the Openwings Management Services framework.
MBeanAdapter - interface net.openwings.management.MBeanAdapter.
This interface defines a plugin for an adapter that makes MBeans accessible to another management framework (such as JMX or SNMP).
MEMORY - Static variable in interface net.openwings.container.utilities.PlatformPerformance
The name of PerformanceReports for memory usage.
MOVED_CONTAINER - Static variable in class net.openwings.container.ContainerProcessStatus
This constant represents a transitory state for a process that is being moved to another container on the same platform.
MOVED_CONTAINER_MANAGER - Static variable in class net.openwings.container.ContainerProcessStatus
This constant represents the state of a process that has been moved to another container on a different platform.
ManagementPolicy - interface net.openwings.management.ManagementPolicy.
This interface defines a policy which describes configurable management parameters of a component that should be registered upon initialization of the Manager: Default MBeans MBean User Interface Factories MBeanAdapters
Manager - interface net.openwings.management.Manager.
This interface is the centerpiece of the Openwings Management architecture.
ManagerFactory - class net.openwings.management.ManagerFactory.
This class provides a way to obtain an implementation of Manager.
ManagerListener - interface net.openwings.management.ManagerListener.
This interface describes a callback that can be registered with a Manager to receive notification when an MBean is added or removed from a Manager or RemoteManager
MobileProcess - interface net.openwings.container.MobileProcess.
This interface represents a single execution of a process running inside a Container or ContainerManager.
MobileProcessListener - interface net.openwings.container.MobileProcessListener.
This interface describes a callback that can be used to register interest in receiving notification when the serialized state of processes from a MobileProcess, Container, or ContainerManager are updated.
main(String[]) - Static method in class net.openwings.identity.PropertyInitializer
This main is for testing purposes only.
modifyUser(String, String[], String, String) - Method in interface net.openwings.security.SecurityService
This method modifies a user in the system.
modifyUserPassword(String, String, String) - Method in interface net.openwings.security.SecurityService
This method modifies a user's password in the system.
modifyUserRoles(String, String[]) - Method in interface net.openwings.security.SecurityService
This method modifies a user's roles in the system.

N

NA - Static variable in class net.openwings.availability.UnitReport
This constant is used to indicate that a unit is not applicable.
NETWORK - Static variable in interface net.openwings.container.utilities.PlatformPerformance
The name of PerformanceReports for network interfaces
NOT_ACTIVE - Static variable in class net.openwings.availability.UnitReport
This constant is used to indicate that a unit is not active
NO_RESPONSE - Static variable in class net.openwings.availability.UnitReport
This constant is used to indicate that a unit is not responding.
name - Variable in class net.openwings.availability.PerformanceReport
This is the name of the measurement.
net.openwings.availability - package net.openwings.availability
This package contains the Openwings Availability API.
net.openwings.component - package net.openwings.component
This package contains the Openwings Component Services API.
net.openwings.component.utilities - package net.openwings.component.utilities
This package contains utilities related to Openwings Component Services API.
net.openwings.connector - package net.openwings.connector
This package contains the Openwings Connector Services API.
net.openwings.connector.asynchronous - package net.openwings.connector.asynchronous
This package contains the asynchronous portion of the Openwings Connector Services API.
net.openwings.connector.synchronous - package net.openwings.connector.synchronous
This package contains the synchronous portion of the Openwings Connector Services API.
net.openwings.connector.utilities - package net.openwings.connector.utilities
This package contains utilities related to the Openwings Connector Services API.
net.openwings.container - package net.openwings.container
This package contains the Openwings Container Services API.
net.openwings.container.utilities - package net.openwings.container.utilities
 
net.openwings.context - package net.openwings.context
This package contains the Openwings Context Services API.
net.openwings.identity - package net.openwings.identity
This package contains identity-related classes used throughout the Openwings API.
net.openwings.install - package net.openwings.install
This package contains the Openwings Install Services API.
net.openwings.management - package net.openwings.management
This package contains the Openwings Management Services API.
net.openwings.policy - package net.openwings.policy
This package contains the Openwings Policy Services API.
net.openwings.security - package net.openwings.security
This package contains the Openwings Security Services API.
net.openwings.service - package net.openwings.service
This package contains classes related to service interfaces in the Openwings API.
net.openwings.ui - package net.openwings.ui
This package contains classes related to the use of User Interfaces throughout the Openwings API.
numerator - Variable in class net.openwings.availability.PerformanceReport
This is the actual resource usage reading.

O

OFFLINE - Static variable in class net.openwings.availability.UnitReport
This constant is used to indicate that a unit is unavailable.
ONLINE - Static variable in class net.openwings.availability.UnitReport
This constant is used to indicate that a unit is available.
OpenwingsRole - class net.openwings.security.OpenwingsRole.
This interface represents the abstract notion of a user role.
OpenwingsRole(String) - Constructor for class net.openwings.security.OpenwingsRole
This constructs an Openwings role based on a role name.
overrideComponentDescriptor(InstallableComponentDescriptor) - Method in interface net.openwings.install.InstallerMBean
This method is used to override the descriptor for a component installed by the Installer service.

P

POLICY_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 policies directory.
PROCESSOR - Static variable in interface net.openwings.container.utilities.PlatformPerformance
The name of PerformanceReports for CPU usage
PROCESS_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 standalone process.
PROFILE_DESCRIPTOR - Static variable in interface net.openwings.container.ContainerAttributeConstants
This constant is the name of an property that should be set on a ComponentDescriptor that describes how to run an Openwings-compliant container.
PROPERTY_FILE_PROPERTY - Static variable in class net.openwings.identity.PropertyInitializer
This constant denotes the property name used to get the properties file.
PerformanceReport - class net.openwings.availability.PerformanceReport.
This class is used to report a performance metric.
PerformanceReport() - Constructor for class net.openwings.availability.PerformanceReport
Default constructor.
PerformanceReport(String, int, float, float, float, String) - Constructor for class net.openwings.availability.PerformanceReport
This is the primary constructor for this class.
PerformanceReportListener - interface net.openwings.availability.PerformanceReportListener.
This interface describes a listener that may be registered with the AvailabilityMBean to receive periodic performance reports.
PerformanceThreshold - class net.openwings.container.utilities.PerformanceThreshold.
This class describes the thresholds for GREEN/YELLOW/RED status for a particular type of performance report.
PerformanceThreshold() - Constructor for class net.openwings.container.utilities.PerformanceThreshold
Default Constructor.
PerformanceThreshold(String, float, float) - Constructor for class net.openwings.container.utilities.PerformanceThreshold
This is the single public constructor for this class
PlatformDescriptor - class net.openwings.context.PlatformDescriptor.
This class defines the information that makes up a platform descriptor.
PlatformDescriptor() - Constructor for class net.openwings.context.PlatformDescriptor
Default constructor.
PlatformDescriptor(UniqueID, String, boolean) - Constructor for class net.openwings.context.PlatformDescriptor
This constructor sets the value of the platform desciptor.
PlatformListener - interface net.openwings.context.PlatformListener.
This interface describes a callback that can be registered with a Context to be notified when platforms are added to the Context or deleted from the Context.
PlatformPerformance - interface net.openwings.container.utilities.PlatformPerformance.
This interface describes a plug-in that reports performance statistics for a platform.
Policy - interface net.openwings.policy.Policy.
This interface provides the basis for defining policies in Openwings.
PolicyException - exception net.openwings.policy.PolicyException.
This class defines an exception specific to policies.
PolicyException() - Constructor for class net.openwings.policy.PolicyException
Constructs a PolicyException with no specified detail message.
PolicyException(String) - Constructor for class net.openwings.policy.PolicyException
Constructs a PolicyException with the specified detail message.
PolicyException(Exception, String) - Constructor for class net.openwings.policy.PolicyException
Constructs a new PolicyException.
PolicyGenerator - interface net.openwings.policy.PolicyGenerator.
This interface describes a utility that can be used to generate policies.
PolicyListener - interface net.openwings.context.PolicyListener.
This interface describes a callback that can be registered with a Context to be notified when policies are added, changed, or deleted in a Context.
PolicyLoader - interface net.openwings.policy.PolicyLoader.
This interface describes a utility that instantiates Policy objects and loads their saved state.
PolicyLoaderFactory - class net.openwings.policy.PolicyLoaderFactory.
This class provides a way to obtain an implementation of PolicyLoader.
ProcessAccess - interface net.openwings.container.ProcessAccess.
This interface describes a callback that can be registered by a process (an Openwings Component or other Java program) with its container via the ContainerAccess interface.
ProcessCreationException - exception net.openwings.container.ProcessCreationException.
This class is an exception which indicates a problem with the creation of a process in a Container or ContainerManager.
ProcessCreationException(String, Exception) - Constructor for class net.openwings.container.ProcessCreationException
This constructor wraps some underlying exception.
ProcessCreationException(String) - Constructor for class net.openwings.container.ProcessCreationException
Simple Constructor
ProcessShutdown - interface net.openwings.container.ProcessShutdown.
This interface describes a callback that can be registered by a process (an Openwings Component or other Java program) with its container via the ContainerAccess interface.
PropertyInitializer - class net.openwings.identity.PropertyInitializer.
This class is a utility for setting system properties.
PropertyListener - interface net.openwings.context.PropertyListener.
This interface describes a callback that can be registered with a Context to be notified when properties are added, changed, or deleted in a Context.
ProtocolAttributes - interface net.openwings.connector.ProtocolAttributes.
An object is a ProtocolAttributes object if it contains unique information about the configuration of a connector.
ProvideServiceParameters - class net.openwings.component.ProvideServiceParameters.
This class defines an object which can be passed to the provideService() method of the ComponentComplex interface to specify configuration information and behavior relevant to providing services.
ProvideServiceParameters() - Constructor for class net.openwings.component.ProvideServiceParameters
default constructor
ProvideServiceParameters(String, String, String, String, String, String, UniqueID, UserInterfaceFactory[], Attribute[]) - Constructor for class net.openwings.component.ProvideServiceParameters
general constructor
ProvideServicePolicy - interface net.openwings.component.ProvideServicePolicy.
This interface defines a policy which can be used to persist a ProvideServiceParameters() object that is intended to be passed to one of the ComponentComplex.provideService() methods to specify configuration information and behavior relevant to providing a service.
ProviderProxy - interface net.openwings.connector.synchronous.ProviderProxy.
This class contains the methods that are to be implemented by a service's provider proxy.
PublishServiceParameters - class net.openwings.component.PublishServiceParameters.
This class defines an object which can be passed to the publishService() method of the ComponentComplex interface to specify configuration information and behavior relevant to creating an asynchronous service (topic).
PublishServiceParameters() - Constructor for class net.openwings.component.PublishServiceParameters
default constructor
PublishServiceParameters(String, String, String, String, String, String, UniqueID, UserInterfaceFactory[], UserInterfaceFactory[], Attribute[]) - Constructor for class net.openwings.component.PublishServiceParameters
general constructor
PublishServicePolicy - interface net.openwings.component.PublishServicePolicy.
This interface defines a policy which can be used to persist a PublishServiceParameters() object that is intended to be passed to the ComponentComplex.publishService(Class, PublishServiceParameters) method to specify configuration information and behavior relevant to creating an asynchronous service (topic).
PublisherProxy - interface net.openwings.connector.asynchronous.PublisherProxy.
This interface contains the methods that are to be implemented by a service's publisher proxy.
packageMapping(Class) - Method in interface net.openwings.policy.PolicyLoader
Get an Iterator over the mappings of a Policy class to an implementation package.
percentage - Variable in class net.openwings.availability.PerformanceReport
This indicates the percentage utilization of this component.
platformAdded(UniqueID, String, boolean) - Method in interface net.openwings.context.PlatformListener
This method is invoked when a new platform is added to the context.
platformRemoved(UniqueID, String, boolean) - Method in interface net.openwings.context.PlatformListener
This method is invoked when a platform is removed from the context.
policyRemoved(String, Policy) - Method in interface net.openwings.context.PolicyListener
This method is invoked when a policy is removed.
policySet(String, Policy) - Method in interface net.openwings.context.PolicyListener
This method is invoked when a policy is added or changed.
printStackTrace() - Method in class net.openwings.connector.ConnectorCompilerExceptions
This method creates a single string representation of how the stackTraces of all of the exceptions within the collection would have looked if they had been allowed to be thrown up the stack.
printStackTrace() - Method in class net.openwings.connector.ConnectorGeneratorExceptions
This method creates a single string representation of how the stackTraces of all of the exceptions within the collection would have looked if they had been allowed to be thrown up the stack.
printStackTrace() - Method in class net.openwings.policy.PolicyException
Prints this Throwable and its backtrace to the standard error stream.
printStackTrace(PrintStream) - Method in class net.openwings.policy.PolicyException
Prints this Throwable and its backtrace to the standard error stream.
printStackTrace(PrintWriter) - Method in class net.openwings.policy.PolicyException
Prints this Throwable and its backtrace to the standard error stream.
printStackTrace() - Method in class net.openwings.ui.UserInterfaceException
Prints this Throwable and its backtrace to the standard error stream.
printStackTrace(PrintStream) - Method in class net.openwings.ui.UserInterfaceException
Prints this Throwable and its backtrace to the standard error stream.
printStackTrace(PrintWriter) - Method in class net.openwings.ui.UserInterfaceException
Prints this Throwable and its backtrace to the standard error stream.
processMBeanAdded(MBean) - Method in interface net.openwings.management.ManagerListener
Process an event signaling an MBean was added to the Manager.
processMBeanRemoved(MBean) - Method in interface net.openwings.management.ManagerListener
Process an event signaling an MBean was removed from the Manager.
processStateCheckpoint(MobileProcess) - Method in interface net.openwings.container.MobileProcessListener
This method is called when the serialized state of a MobileProcess is updated.
processStatusUpdate(ContainerProcess, ContainerProcessStatus) - Method in interface net.openwings.container.ContainerProcessListener
This method is called when the status of a ContainerProcess changes.
propertyRemoved(String, String) - Method in interface net.openwings.context.PropertyListener
This method is invoked when a property is removed.
propertySet(String, String) - Method in interface net.openwings.context.PropertyListener
This method is invoked when a property is added or changed.
provideService(Class, Object) - Method in interface net.openwings.component.Component
This method is used to make a synchronous (remote method) service available to other components (join).
provideService(Class, Object, UniqueID) - Method in interface net.openwings.component.Component
This method is used to make a synchronous (remote method) service available to other components (join).
provideService(Class, Object, ProvideServiceParameters) - Method in interface net.openwings.component.ComponentComplex
This method is used to make a synchronous (remote method) service available to other components (join).
providedServiceRemoved(UniqueID) - Method in interface net.openwings.component.UseServiceListener
This callback method is invoked whenever a service provider calls the removeService() of the Component interface on a service object previously passed to serviceProvided().
publishService(Class) - Method in interface net.openwings.component.Component
This method is used to indicate that the component will publish an asynchronous (event or messaging) service.
publishService(Class, EventServiceListener) - Method in interface net.openwings.component.Component
This method registers for notification of the ability to publish an asynchronous (event or messaging) service.
publishService(Class, PublishServiceParameters) - Method in interface net.openwings.component.ComponentComplex
This method is used to explicitly create a topic for publishing an asynchronous (event or messaging) service.
publishService(Class, EventServiceParameters) - Method in interface net.openwings.component.ComponentComplex
This method is used to indicate that the component will publish an asynchronous (event or messaging) service.
publishService(Class, EventServiceListener, EventServiceParameters) - Method in interface net.openwings.component.ComponentComplex
This method registers for notification of the ability to publish an asynchronous (event or messaging) service.

R

RED - Static variable in class net.openwings.availability.PerformanceReport
This constant is used to indicate a performance availability fault.
REFERENCE_BEGIN - Static variable in class net.openwings.identity.PropertyInitializer
This constant denotes the beginning of a reference.
REFERENCE_END - Static variable in class net.openwings.identity.PropertyInitializer
This constant denotes the ending of a reference.
REFERENCE_METHOD - Static variable in class net.openwings.identity.PropertyInitializer
This constant denotes a method reference.
RESOLVED - Static variable in class net.openwings.install.InstallableComponentDescriptor
This is the state of a component which has been installed and has no unresolved dependencies.
Reachable - interface net.openwings.availability.Reachable.
This class is used to encapsulate various methods for seeing if an IP address is reachable.
ReachableFactory - class net.openwings.availability.ReachableFactory.
This class provides a way to obtain an implementation of Reachable.
ReachableFactory() - Constructor for class net.openwings.availability.ReachableFactory
 
ReceiverProxy - interface net.openwings.connector.ReceiverProxy.
This class contains the methods that are to be implemented by a service's receiver proxy.
RelationshipListener - interface net.openwings.context.RelationshipListener.
This interface describes a callback that can be registered with a Context to be notified when context relationships are added or removed.
RemoteManager - interface net.openwings.management.RemoteManager.
This interface describes a service which can be used to control the management of a component.
RoleSigner - interface net.openwings.security.RoleSigner.
This interface represents a utility that is used in the construction and comparison of OpenwingsRole objects to access the role's credentials.
RoleSignerFactory - class net.openwings.security.RoleSignerFactory.
This class provides a way to obtain an implementation of RoleSigner.
receiverProxy - Variable in class net.openwings.connector.Connector
This field contains all of the business logic required to recieve calls from a SenderProxy and relay it to a reciever object.
registerContainerProcessListener(ContainerProcessListener) - Method in interface net.openwings.container.Container
This method is used to register interest in receiving process status updates for every process in a container.
registerContainerProcessListener(ContainerProcessListener) - Method in interface net.openwings.container.ContainerProcess
This method is used to register interest in receiving process status updates from a ContainerProcess.
registerMobileProcessListener(MobileProcessListener) - Method in interface net.openwings.container.Container
This method is used to register interest in receiving the serialized state of every process in the container that supports state serialization.
registerMobileProcessListener(MobileProcessListener) - Method in interface net.openwings.container.MobileProcess
This method is used to register interest in receiving the serialized state of a MobileProcess.
registerProcessAccess(ProcessAccess) - Method in interface net.openwings.container.ContainerAccess
This method is used by a process (an Openwings Component or other Java program) to register a callback that can be used by its container to pull the state of the process asynchronously.
registerProcessShutdown(ProcessShutdown) - Method in interface net.openwings.container.ContainerAccess
This method is used by a process (an Openwings Component or other Java program) to register a callback that can be used by its container to shut down the process cleanly.
relationshipAdded(UniqueID, String) - Method in interface net.openwings.context.RelationshipListener
This method is invoked when a relationship is added.
relationshipRemoved(UniqueID, String) - Method in interface net.openwings.context.RelationshipListener
This method is invoked when a relationship is removed.
removeContext() - Method in interface net.openwings.context.Context
This method is used to remove / destroy this context.
removeEventServiceListener(Class, EventServiceListener) - Method in interface net.openwings.component.Component
This method stops notification of asynchronous (event or messaging) services created by other components.
removeHeartbeatListener(HeartbeatListener) - Method in interface net.openwings.availability.AvailabilityMBean
This method is used to remove a listener that receives periodic heartbeat events.
removeInstallListener(InstallListener) - Method in interface net.openwings.install.Installer
This method is used to remove an installation listener.
removeListener(VisibleListener) - Method in interface net.openwings.availability.Visible
This method is used to remove an VisibleListener that is listening for a change in a Connection's status.
removeMBean(MBean) - Method in interface net.openwings.management.Manager
This method removes an MBean from this Manager.
removeMBeanAdapter(MBeanAdapter) - Method in interface net.openwings.management.Manager
This method removes an MBeanAdapter.
removeManagerListener(ManagerListener) - Method in interface net.openwings.management.RemoteManager
This method unregisters a previously registered ManagerListener.
removePerformanceReportListener(PerformanceReportListener) - Method in interface net.openwings.availability.AvailabilityMBean
This method is used to remove a listener that receives periodic performance updates.
removePlatform(UniqueID, String) - Method in interface net.openwings.context.Context
This method is used to remove a platform from a context.
removePlatformListener(PlatformListener) - Method in interface net.openwings.context.Context
This method is used to remove a listener that is notified when platforms are added to the context or deleted from the Context.
removePolicy(String) - Method in interface net.openwings.context.Context
This method is used to remove a policy from the context.
removePolicyListener(PolicyListener) - Method in interface net.openwings.context.Context
This method is used to remove a listener that is notified when policies are added, changed, or deleted in a context.
removeProperty(String) - Method in interface net.openwings.context.Context
This method is used to remove a property from the context.
removePropertyListener(PropertyListener) - Method in interface net.openwings.context.Context
This method is used to remove a listener that is notified when properties are added, changed, or deleted in a Context.
removeProvidedService(UniqueID) - Method in interface net.openwings.component.Component
This method is used to make a synchronous (remote method) service unavailable for use by other components.
removePublisherUIFactory(UserInterfaceFactory) - Method in class net.openwings.component.PublishServiceParameters
This convenience method removes a user interface factory return true if the factory was removed from the set
removeRelationship(UniqueID, String) - Method in interface net.openwings.context.Context
This method is used to remove a relationship between this context and another.
removeRelationshipListener(RelationshipListener) - Method in interface net.openwings.context.Context
This method is used to remove a listener that is notified when context relationships are added or removed.
removeRequiredAttribute(Attribute) - Method in class net.openwings.component.EventServiceParameters
This convenience method removes a service attribute return the attribute, or null if the attribute is not in the list
removeRequiredAttribute(String) - Method in class net.openwings.component.EventServiceParameters
This convenience method removes a service attribute by name return the attribute, or null if the attribute is not in the list
removeRequiredAttribute(Attribute) - Method in class net.openwings.component.UseServiceParameters
This convenience method removes a service attribute return the attribute, or null if the attribute is not in the list
removeRequiredAttribute(String) - Method in class net.openwings.component.UseServiceParameters
This convenience method removes a service attribute by name return the attribute, or null if the attribute is not in the list
removeRunnableProcess(ComponentDescriptor) - Method in interface net.openwings.container.ContainerManagerMBean
This method removes a process from the list of processes the ContainerManager is able to run.
removeRunnableProcesses(UniqueID, ComponentDescriptor[]) - Method in interface net.openwings.container.ContainerManagerListener
This method should be called when a ContainerManager has processes (components) that it is no longer able to run.
removeServiceAttribute(Attribute) - Method in class net.openwings.component.ProvideServiceParameters
This convenience method removes a service attribute return the attribute, or null if the attribute is not in the list
removeServiceAttribute(String) - Method in class net.openwings.component.ProvideServiceParameters
This convenience method removes a service attribute by name return the attribute, or null if the attribute is not in the list
removeServiceAttribute(Attribute) - Method in class net.openwings.component.PublishServiceParameters
This convenience method removes a service attribute return the attribute, or null if the attribute is not in the list
removeServiceAttribute(String) - Method in class net.openwings.component.PublishServiceParameters
This convenience method removes a service attribute by name return the attribute, or null if the attribute is not in the list
removeSignerCertificate(Certificate[]) - Method in interface net.openwings.security.SecurityService
This method is used to remove signer certificates from the system.
removeSubscriberUIFactory(UserInterfaceFactory) - Method in class net.openwings.component.PublishServiceParameters
This convenience method removes a user interface factory return true if the factory was removed from the set
removeUnitReportListener(UnitReportListener) - Method in interface net.openwings.availability.AvailabilityMBean
This method is used to remove a listener that receives unit fault reports.
removeUseServiceListener(Class, UseServiceListener) - Method in interface net.openwings.component.Component
This method stops notification of synchronous services provided by other components.
removeUserInterfaceFactory(UserInterfaceFactory) - Method in class net.openwings.component.ProvideServiceParameters
This convenience method removes a user interface factory return true if the factory was removed from the set
removeUserInterfaceFactory(UserInterfaceFactory) - Method in interface net.openwings.management.Manager
This method removes a user interface factory from this Manager.
removeVoter(Voter) - Method in interface net.openwings.install.Installer
This method is used to remove a voter.
reportPerformance(PerformanceReport[]) - Method in interface net.openwings.availability.PerformanceReportListener
This method is used to deliver performance reports.
reportPerformance(UniqueID, PerformanceReport[]) - Method in interface net.openwings.container.ContainerListener
This method should be called when a Container updates its performance report data.
reportUnitFault(UnitReport[]) - Method in interface net.openwings.availability.UnitReportListener
This method is used to get the percentage utilization of this metric.
requestProcessStateUpdate() - Method in interface net.openwings.container.ProcessAccess
This method is called by the container to request a process state update.
retrieveProcessState() - Method in interface net.openwings.container.ContainerAccess
This method is used by a process (an Openwings Component or other Java program) to obtain its saved state.

S

SOURCE_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 source directory.
STARTED - Static variable in class net.openwings.container.ContainerProcessStatus
This constant represents the state of a process that is executing in a Container or ContainerManager.
STOPPED - Static variable in class net.openwings.container.ContainerProcessStatus
This constant represents the state of a process that has been explicitly stopped or that has exceeded the maximum number of restarts supported by its container.
SecurityService - interface net.openwings.security.SecurityService.
This interface describes a service that manages users, roles and trust relationsips with other platforms or contexts.
SenderProxy - interface net.openwings.connector.SenderProxy.
This class contains the methods that are to be implemented by a service's sender proxy.
ServiceDescriptor - class net.openwings.component.utilities.ServiceDescriptor.
This class is used to provide metadata about a service being implemented or used by a component.
ServiceDescriptor() - Constructor for class net.openwings.component.utilities.ServiceDescriptor
Default constructor - empty
ServiceDescriptor(Class, UniqueID, boolean) - Constructor for class net.openwings.component.utilities.ServiceDescriptor
This is the primary constructor for the ServiceDescriptor class.
ServiceInterfaceChecker - class net.openwings.service.ServiceInterfaceChecker.
This class provides static methods that check synchronous and asynchronous service interfaces according to the standards outlined in the Openwings Interface Specification.
ServiceInterfaceException - exception net.openwings.service.ServiceInterfaceException.
This class is an exception that is thrown to indicate that a service interface is invalid.
ServiceInterfaceException(String) - Constructor for class net.openwings.service.ServiceInterfaceException
This constructor creates an exception with the corresponding error message.
ServiceInterfaceException() - Constructor for class net.openwings.service.ServiceInterfaceException
Default constructor
ServicePermission - class net.openwings.security.ServicePermission.
This class defines a permission which is used to access services in Openwings.
ServicePermission(String) - Constructor for class net.openwings.security.ServicePermission
This constructor creates a ServicePermission with the specified name.
ServicePermission(Class) - Constructor for class net.openwings.security.ServicePermission
This constructor creates a ServicePermission for all methods in the specified class.
ServiceResult - class net.openwings.component.ServiceResult.
This class is used to associate a used service object with its unique service identifier and additional information such as service attributes and user interfaces.
ServiceResult() - Constructor for class net.openwings.component.ServiceResult
Default constructor.
ServiceResult(UniqueID, UniqueID, Object, Attribute[], Object, UserInterfaceFactory[]) - Constructor for class net.openwings.component.ServiceResult
Simple constructor.
SubscriberProxy - interface net.openwings.connector.asynchronous.SubscriberProxy.
This class contains the methods that are to be implemented by a service's subscriber proxy.
SynchronousConnector - class net.openwings.connector.synchronous.SynchronousConnector.
This class contains the proxies for a synchronous connector.
SynchronousConnector() - Constructor for class net.openwings.connector.synchronous.SynchronousConnector
Default constructor
SynchronousConnector(ProtocolAttributes) - Constructor for class net.openwings.connector.synchronous.SynchronousConnector
This constructor allows the protocol-specific attributes to be passed
savePolicy(URL) - Method in interface net.openwings.policy.Policy
Save the policy configuration data to the URL.
savePolicy(File) - Method in interface net.openwings.policy.Policy
Save the policy configuration data to the File.
savePolicy() - Method in interface net.openwings.policy.Policy
Save the policy configuration data to the file or URL where it was originally loaded from.
senderProxy - Variable in class net.openwings.connector.Connector
This field contains all of the business logic required for a sender object to make seamless calls to a reciever object.
serviceAvailable(Class, ServiceResult) - Method in interface net.openwings.component.EventServiceListener
This callback method is invoked when a new asynchronous service becomes available which meets the criteria passed to the publishService() method of the Component interface.
serviceProvided(Class, ServiceResult) - Method in interface net.openwings.component.UseServiceListener
This callback method is invoked when a new service becomes available which meets the criteria passed to the useService() method of the Component interface.
serviceUnavailable(UniqueID) - Method in interface net.openwings.component.EventServiceListener
This callback method is invoked when the service publisher that created a service (topic) unpublishes a service previously passed to servicePublished().
setAcceptDistributedObjectsImmediately(boolean) - Method in class net.openwings.component.UseServiceParameters
This method sets a flag to indicate whether a service (or services) should be connected immediately or whether the connection should wait until the user calls ComponentComplex.acceptDistributedObject(), passing the service object.
setBinDirectory(String) - Method in class net.openwings.install.InstallableComponentDescriptor
This method sets the relative location of the bin directory within the installable image jar file.
setBootProcessHint(boolean) - Method in class net.openwings.identity.ComponentDescriptor
This method sets a flag indicating whether the component should be started on platform boot.
setBuildUIImmediately(boolean) - Method in class net.openwings.component.EventServiceParameters
This method sets a flag that indicates whether the user interface for a used service should built immediately upon locating the service.
setBuildUIImmediately(boolean) - Method in class net.openwings.component.UseServiceParameters
This method sets a flag that indicates whether the user interface for a used service should built immediately upon locating the service.
setBytes(byte[]) - 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.
setClasspath(URL[]) - Method in class net.openwings.identity.ComponentDescriptor
This method sets the classpath of the component.
setClustered(boolean) - Method in class net.openwings.context.PlatformDescriptor
This method sets whether the platform is part of the context cluster.
setCodebase(URL[]) - Method in class net.openwings.identity.ComponentDescriptor
This method sets the codebase of the component.
setCommandLineParameters(String) - Method in class net.openwings.identity.ComponentDescriptor
This method sets the command line parameters that should be passed to the component on startup.
setComment(String) - Method in class net.openwings.component.ProvideServiceParameters
This method sets a note that describes some aspect of the service
setComment(String) - Method in class net.openwings.component.PublishServiceParameters
This method sets a note that describes some aspect of the service
setComponentDescriptor(ComponentDescriptor) - Method in interface net.openwings.component.ComponentPolicy
 
setComponentDescriptor(InstallableComponentDescriptor) - Method in interface net.openwings.install.InstallableComponentDescriptorPolicy
This method sets the component descriptor stored in the policy.
setComponentID(UniqueID) - Method in class net.openwings.component.EventServiceParameters
This method sets the unique identifier for a component.
setComponentID(UniqueID) - Method in class net.openwings.component.ServiceResult
This method sets the global unique service identifier for the component that provided this synchronous service / created this asynchronous service (topic), if known.
setComponentID(UniqueID) - Method in class net.openwings.component.UseServiceParameters
This method sets the unique identifier for a component.
setComponentName(String) - Method in class net.openwings.identity.ComponentDescriptor
This method sets the name of this component.
setContainerID(UniqueID) - Method in class net.openwings.container.utilities.LoadBalancerContainerInfo
This method sets the unique identifier for the container.
setContext(UniqueID) - Method in class net.openwings.context.ContextDescriptor
This method sets the unique id of the context.
setContext(UniqueID) - Method in interface net.openwings.security.SecurityService
This method is used to tell the platform what context it is a member of.
setDataDirectory(String) - Method in class net.openwings.install.InstallableComponentDescriptor
This method sets the relative location of the data directory within the installable image jar file.
setDegraded(boolean) - Method in class net.openwings.availability.UnitReport
This method is used to set the degraded status.
setDenominator(float) - Method in class net.openwings.availability.PerformanceReport
This method is used to set the denominator of the measurement.
setDescription(String) - Method in class net.openwings.availability.UnitReport
This method is used to set the desription of the fault.
setDescription(String) - Method in class net.openwings.identity.ComponentDescriptor
This method sets a description of the component.
setDescription(String) - Method in interface net.openwings.policy.Policy
Set a human-readable description for this Policy.
setDesiredUIClass(Class) - Method in class net.openwings.component.EventServiceParameters
This method sets the desired type of user interface for a service, based on the class of the UI object.
setDesiredUIClass(Class) - Method in class net.openwings.component.UseServiceParameters
This method sets the desired type of user interface for a service, based on the class of the UI object.
setDesiredUIConstructorParameters(Object[]) - Method in class net.openwings.component.EventServiceParameters
This method sets parameters that are to be passed to the constructor of a UI object by a UI factory.
setDesiredUIConstructorParameters(Object[]) - Method in class net.openwings.component.UseServiceParameters
This method sets parameters that are to be passed to the constructor of a UI object by a UI factory.
setDisplayName(String) - Method in class net.openwings.component.ProvideServiceParameters
This method sets a name for the service which is intended for users to read, perhaps in a service browser or web browser
setDisplayName(String) - Method in class net.openwings.component.PublishServiceParameters
This method sets a name for the service which is intended for users to read, perhaps in a service browser or web browser
setDocsDirectory(String) - Method in class net.openwings.install.InstallableComponentDescriptor
This method sets the relative location of the docs directory within the installable image jar file.
setExecutable(boolean) - Method in class net.openwings.identity.ComponentDescriptor
This method sets whether the component is executable.
setExecutableString(String) - Method in class net.openwings.identity.ComponentDescriptor
This method sets the executableString used to execute the component.
setHttpDirectory(String) - Method in class net.openwings.install.InstallableComponentDescriptor
This method sets the relative location of the http directory within the installable image jar file.
setIconFile(String) - Method in class net.openwings.install.InstallableComponentDescriptor
This method sets the relative location of the icon file for this component within the installable image jar file.
setIconResource(String) - Method in class net.openwings.component.ProvideServiceParameters
This method sets the the name of a resource that is an icon that can be used to depict this service.
setIconResource(String) - Method in class net.openwings.component.PublishServiceParameters
This method sets the the name of a resource that is an icon that can be used to depict this service.
setImplementsInterface(boolean) - Method in class net.openwings.component.utilities.ServiceDescriptor
This method tells whether this service is implemented locally or remotely.
setInstallState(int) - Method in class net.openwings.install.InstallableComponentDescriptor
This method sets the state of this component: UNINSTALLED, AUTHENTICATED, INSTALLED, or RESOLVED.
setLibDirectory(String) - Method in class net.openwings.install.InstallableComponentDescriptor
This method sets the relative location of the lib directory within the installable image jar file.
setLoadBalancerImplementation(String) - Method in interface net.openwings.container.utilities.ContainerManagerPolicy
This method sets the name of the class containing the implementation of the LoadBalancer implementation
setLoadBalancerProcessInfoList(LoadBalancerProcessInfo[]) - Method in class net.openwings.container.utilities.LoadBalancerContainerInfo
This method sets information about the mobile processes in the container.
setMBeanAdapterClasses(Class[]) - Method in interface net.openwings.management.ManagementPolicy
This method sets the MBeanAdapters to be used by the Manager
setMBeanClasses(Class[]) - Method in interface net.openwings.management.ManagementPolicy
This method sets the default MBeans to be created by the Manager
setMaximumNumberOfResults(int) - Method in class net.openwings.component.UseServiceParameters
This method sets an integer that represents an upper limit on the number of ServiceResult objects that should be returned from a call to ComponentComplex.useService().
setMobile(boolean) - Method in class net.openwings.identity.ComponentDescriptor
This method sets a flag indicating whether the component can move between containers or platforms.
setName(String) - Method in class net.openwings.availability.PerformanceReport
This method is used to set the name of the performance metric.
setName(String) - Method in class net.openwings.availability.UnitReport
This method is used to set the name of the unit under test.
setName(String) - Method in class net.openwings.context.ContextDescriptor
This method sets the name of the context.
setName(String) - Method in class net.openwings.context.PlatformDescriptor
This method sets the name of the platform.
setName(String) - Method in class net.openwings.identity.Attribute
This method sets the name / key for the attribute
setName(String) - Method in interface net.openwings.policy.Policy
Assign a name to this Policy.
setNewContainerID(UniqueID) - Method in class net.openwings.container.utilities.LoadBalancerAssignment
This method returns the unique identifier for the new container.
setNumerator(float) - Method in class net.openwings.availability.PerformanceReport
This method is used to set the numerator of the measurement.
setOldContainerID(UniqueID) - Method in class net.openwings.container.utilities.LoadBalancerAssignment
This method sets the unique identifier for the old container.
setParameters(EventServiceParameters) - Method in interface net.openwings.component.EventServicePolicy
This method sets the parameters for publishing/subscribing to some service.
setParameters(ProvideServiceParameters) - Method in interface net.openwings.component.ProvideServicePolicy
This method sets the parameters for using some service.
setParameters(PublishServiceParameters) - Method in interface net.openwings.component.PublishServicePolicy
This method sets the parameters for creating an asynchronous service (topic).
setParameters(UseServiceParameters) - Method in interface net.openwings.component.UseServicePolicy
This method sets the parameters for using some service.
setPercentUsage(float) - Method in class net.openwings.availability.PerformanceReport
This method is used to set the percentage utilization of this metric.
setPerformanceReports(PerformanceReport[]) - Method in class net.openwings.container.utilities.LoadBalancerContainerInfo
This method sets the performance reports for the container.
setPerformanceReports(PerformanceReport[]) - Method in class net.openwings.container.utilities.LoadBalancerProcessInfo
This method sets the performance reports for the process.
setPerformanceThresholds(PerformanceThreshold[]) - Method in interface net.openwings.container.utilities.ContainerManagerPolicy
This method sets the thresholds that determine the GREEN/YELLOW/RED designation for a particular type of PerformanceReport
setPerformanceThresholds(PerformanceThreshold[]) - Method in interface net.openwings.container.utilities.PlatformPerformance
Sets the thresholds to calculate GREEN/YELLOW/RED performance flags for various types of performance reports.
setPlatform(UniqueID) - Method in class net.openwings.context.PlatformDescriptor
This method sets the unique id of the platform.
setPlatform(String) - Method in class net.openwings.identity.ComponentDescriptor
This method sets the platform on which this component can run.
setPlatformPerformanceImplementation(String) - Method in interface net.openwings.container.utilities.ContainerManagerPolicy
This method sets the name of the class containing the implementation of the PlatformPerformance implementation
setPolicy(String, Policy) - Method in interface net.openwings.context.Context
This method is used to set a policy for the context.
setPolicyDirectory(String) - Method in class net.openwings.install.InstallableComponentDescriptor
This method sets the relative location of the policies directory within the installable image jar file.
setPolicyUpdated(boolean) - Method in interface net.openwings.policy.Policy
Sets the update status of this policy.
setProcessID(UniqueID) - Method in class net.openwings.container.utilities.LoadBalancerAssignment
This method sets the unique identifier for the process.
setProcessID(UniqueID) - Method in class net.openwings.container.utilities.LoadBalancerProcessInfo
This method sets the unique identifier for the process.
setProperties(Properties) - Method in class net.openwings.identity.ComponentDescriptor
This method sets the properties used by the component.
setProperty(String, String) - Method in interface net.openwings.context.Context
This method is used to set a property for the context.
setPublisherUIFactories(UserInterfaceFactory[]) - Method in class net.openwings.component.PublishServiceParameters
This method sets the array of UserInterfaceFactory objects that will be provided along with the service for use by publishers
setRedThreshold(float) - Method in class net.openwings.container.utilities.PerformanceThreshold
This method sets the threshold indicating imminent failure.
setReportName(String) - Method in class net.openwings.container.utilities.PerformanceThreshold
This method sets the name of the report.
setRequiredAttributes(Attribute[]) - Method in class net.openwings.component.EventServiceParameters
This method sets required attributes for a service
setRequiredAttributes(Attribute[]) - Method in class net.openwings.component.UseServiceParameters
This method sets required attributes for a service
setResolvableClasspath(String[]) - Method in class net.openwings.install.InstallableComponentDescriptor
This method sets an array of strings used to build the classpath field of this descriptor.
setResolvableCodebase(String[]) - Method in class net.openwings.install.InstallableComponentDescriptor
This method returns an array of strings used to build the codebase field of this descriptor.
setRestartHint(boolean) - Method in class net.openwings.identity.ComponentDescriptor
This method sets a flag indicating whether the component should be restarted in case of failure.
setReturnServiceAttributes(boolean) - Method in class net.openwings.component.EventServiceParameters
This method sets a flag that indicates whether the attributes of a used service should be returned in the serviceAttributes field of a ServiceResult (or ServiceResult).
setReturnServiceAttributes(boolean) - Method in class net.openwings.component.UseServiceParameters
This method sets a flag that indicates whether the attributes of a used service should be returned in the serviceAttributes field of a ServiceResult.
setReturnUserInterfaceFactories(boolean) - Method in class net.openwings.component.EventServiceParameters
This method sets a flag that indicates whether the user interface factories attached to a used service should be returned in the userInterfaceFactories field of a ServiceResult.
setReturnUserInterfaceFactories(boolean) - Method in class net.openwings.component.UseServiceParameters
This method sets a flag that indicates whether the user interface factories attached to a used service should be returned in the userInterfaceFactories field of a ServiceResult.
setRunImmediatelyHint(boolean) - Method in class net.openwings.identity.ComponentDescriptor
This method sets a flag indicating whether the component should be started immediately.
setSerialNumber(String) - Method in class net.openwings.component.ProvideServiceParameters
This method sets the serial number of the service
setSerialNumber(String) - Method in class net.openwings.component.PublishServiceParameters
This method sets the serial number of the service
setServeHint(boolean) - Method in class net.openwings.install.InstallableComponentDescriptor
This method sets a flag that indicates whether this component should be served to other platforms (via a web server).
setService(Object) - Method in class net.openwings.component.ServiceResult
This method sets the service object.
setServiceAttributes(Attribute[]) - Method in class net.openwings.component.ProvideServiceParameters
This method sets attributes describing a service
setServiceAttributes(Attribute[]) - Method in class net.openwings.component.PublishServiceParameters
This method sets attributes describing a service
setServiceAttributes(Attribute[]) - Method in class net.openwings.component.ServiceResult
This method sets the attributes that describe the service
setServiceDescription(String) - Method in class net.openwings.component.ProvideServiceParameters
This method sets a longer textual description of the service
setServiceDescription(String) - Method in class net.openwings.component.PublishServiceParameters
This method sets a longer textual description of the service
setServiceID(UniqueID) - Method in class net.openwings.component.EventServiceParameters
This method sets the unique identifier for a desired service.
setServiceID(UniqueID) - Method in class net.openwings.component.ProvideServiceParameters
This method sets the unique identifier that should be used to identify the service when it is provided
setServiceID(UniqueID) - Method in class net.openwings.component.PublishServiceParameters
This method sets the unique identifier that should be used to identify the service when it is provided
setServiceID(UniqueID) - Method in class net.openwings.component.ServiceResult
This method sets the global unique service identifier for this service
setServiceID(UniqueID) - Method in class net.openwings.component.UseServiceParameters
This method sets the unique identifier for a desired service.
setServiceImpl(Object) - Method in interface net.openwings.connector.ReceiverProxy
This method is used to set the service implementation of the ReceiverProxy
setServiceInterface(Class) - Method in class net.openwings.component.utilities.ServiceDescriptor
This method sets the class of the service interface.
setServiceName(String) - Method in class net.openwings.component.ProvideServiceParameters
This method sets a name that will be used to describe the service
setServiceName(String) - Method in class net.openwings.component.PublishServiceParameters
This method sets a name that will be used to describe the service
setSharedContainerHint(boolean) - Method in class net.openwings.identity.ComponentDescriptor
This method sets a flag indicating whether the component can share a container with other components.
setSourceDirectory(String) - Method in class net.openwings.install.InstallableComponentDescriptor
This method sets the relative location of the source directory within the installable image jar file.
setState(int) - Method in class net.openwings.availability.UnitReport
This method is used to set the state of this unit.
setStatus(int) - Method in class net.openwings.availability.PerformanceReport
This method is used to set the status of this performance metric.
setStatus(int) - Method in class net.openwings.availability.UnitReport
This method is used to set the status of this unit.
setSubscriberUIFactories(UserInterfaceFactory[]) - Method in class net.openwings.component.PublishServiceParameters
This method sets the array of UserInterfaceFactory objects that will be provided along with the service for use by subscribers
setSupportedServiceInterface(Class) - Method in class net.openwings.component.utilities.UserInterfaceDescriptor
This method sets the service interface supported by the user interface
setSupportedUIClass(Class) - Method in class net.openwings.component.utilities.UserInterfaceDescriptor
This method sets the the Java type of the user interface.
setTimeout(int) - Method in interface net.openwings.availability.Reachable
This method is used to set the timeout duration.
setTimestamp(Date) - Method in class net.openwings.availability.UnitReport
This method is used to set the date.
setUniqueID(UniqueID) - Method in class net.openwings.component.utilities.ServiceDescriptor
This method sets the unique identifier for the service.
setUniqueID(UniqueID) - Method in class net.openwings.identity.ComponentDescriptor
This method sets the unique identifer of this component.
setUnits(String) - Method in class net.openwings.availability.PerformanceReport
This method is used to set the units of the performance metric.
setUserInterface(Object) - Method in class net.openwings.component.ServiceResult
This method sets the user interface object for this service.
setUserInterfaceFactories(UserInterfaceFactory[]) - Method in class net.openwings.component.ProvideServiceParameters
This method sets the array of UserInterfaceFactory objects that will be provided along with the service
setUserInterfaceFactories(UserInterfaceFactory[]) - Method in class net.openwings.component.ServiceResult
This method sets acceptable user interface factories for this service.
setUserInterfaceFactories(UserInterfaceFactory[]) - Method in interface net.openwings.management.ManagementPolicy
This method sets the UserInterfaceFactorys that correspond to the default MBeans
setValue(Object) - Method in class net.openwings.identity.Attribute
This method sets the value of the attribute
setVersion(String) - Method in class net.openwings.identity.ComponentDescriptor
This method sets the version number of this component.
setYellowThreshold(float) - Method in class net.openwings.container.utilities.PerformanceThreshold
This method sets the threshold indicating degraded operation.
shutdown() - Method in interface net.openwings.component.Component
This method is used to terminate all service connections and processing provided by a Component.
shutdown() - Method in interface net.openwings.component.utilities.ComponentMBean
This method shuts down the component, disconnecting all services used and provided by the component.
shutdown() - Method in interface net.openwings.container.Container
This method is used to shutdown a container.
shutdown() - Method in interface net.openwings.container.ProcessShutdown
This method is called by the container to request a process to shutdown.
shutdown() - Method in interface net.openwings.container.utilities.PlatformPerformance
Tells the performance monitor to shut down and release any resources
shutdown() - Method in interface net.openwings.management.MBeanAdapter
This method is used to notify an adapter that the Manager is being shut down.
shutdown() - Method in interface net.openwings.management.Manager
This method is used to terminate all processing provided by a Manager.
start() - Method in interface net.openwings.container.ContainerProcess
This method is used to start the execution of a ContainerProcess object returned from the Container.createProcess() method.
startListening() - Method in interface net.openwings.availability.Visible
This method is used to start listening to determine changes in the online/offline status of a connection.
status - Variable in class net.openwings.availability.PerformanceReport
This is the RED, YELLOW, GREEN status indicator.
stop() - Method in interface net.openwings.container.ContainerProcess
This method is used to explicitly stop the execution of a ContainerProcess object.
stopListening() - Method in interface net.openwings.availability.Visible
This method is used to stop listening to determine changes in the online/offline status of a connection.
subscribeService(Class, Object) - Method in interface net.openwings.component.Component
This method is used to subscribe to a an asynchronous (event or messaging) service.
subscribeService(Class, Object, EventServiceListener) - Method in interface net.openwings.component.Component
This method registers for notification of the ability to subscribe to an asynchronous (event or messaging) service.
subscribeService(Class, Object, EventServiceParameters) - Method in interface net.openwings.component.ComponentComplex
This method is used to subscribe to a an asynchronous (event or messaging) service.
subscribeService(Class, Object, EventServiceListener, EventServiceParameters) - Method in interface net.openwings.component.ComponentComplex
This method registers for notification of the ability to subscribe to an asynchronous (event or messaging) service.
synchronousInterfaceCheck(Class) - Static method in class net.openwings.service.ServiceInterfaceChecker
This method checks that a synchronous interface is a valid service interface.

T

toString() - Method in class net.openwings.availability.PerformanceReport
overrides default toString() method.
toString() - Method in class net.openwings.availability.UnitReport
overrides default toString() method.
toString() - Method in class net.openwings.component.utilities.ServiceDescriptor
overrides default toString() method.
toString() - Method in class net.openwings.component.utilities.UserInterfaceDescriptor
overrides default toString() method.
toString() - Method in class net.openwings.container.utilities.LogAccess.LogFileDescriptor
 
toString() - Method in class net.openwings.context.ContextDescriptor
overrides default toString() method.
toString() - Method in class net.openwings.context.PlatformDescriptor
overrides default toString() method.
toString() - Method in class net.openwings.identity.Attribute
overrides default toString() method.
toString() - Method in class net.openwings.identity.ComponentDescriptor
overrides default toString() method.
toString() - Method in class net.openwings.identity.UniqueID
Returns a hex representation of the bytes as a string, with a space separating each 4-byte (int) group.
toString() - Method in class net.openwings.security.OpenwingsRole
This method overrides the default toString() implementation.
translate(String) - Static method in class net.openwings.identity.PropertyInitializer
This method can be used to translate strings containing property or method references.
translate(String, Properties) - Static method in class net.openwings.identity.PropertyInitializer
This method can be used to translate strings containing property or method references.

U

UNINSTALLED - Static variable in class net.openwings.install.InstallableComponentDescriptor
This is the initial state of a component.
UniqueID - class net.openwings.identity.UniqueID.
This interface defines a unique identifier that can be used throughout the Openwings framework.
UniqueID(byte[]) - Constructor for class net.openwings.identity.UniqueID
This constructor generates a new unique identifier based on an array of bytes.
UniqueID(String) - Constructor for class net.openwings.identity.UniqueID
This constructor generates a new unique identifier based on a string returned from the toString() method
UniqueIDFactory - class net.openwings.identity.UniqueIDFactory.
This class provides a way to obtain a UniqueID.
UniqueIDGenerator - interface net.openwings.identity.UniqueIDGenerator.
This interface describes a plugin that can generate UniqueID instances.
UnitReport - class net.openwings.availability.UnitReport.
This class is used to report a fault in a unit (a component or a specific capability provided by a component).
UnitReport() - Constructor for class net.openwings.availability.UnitReport
Default constructor.
UnitReport(String, String, int, int, Date) - Constructor for class net.openwings.availability.UnitReport
This is the primary constructor for this class.
UnitReportListener - interface net.openwings.availability.UnitReportListener.
This class is used to hide the online, offline, degraded status reporting technique.
UseServiceListener - interface net.openwings.component.UseServiceListener.
This interface defines a callback which can be passed to the useService() methods of the Component interface to register ongoing interest in certain services.
UseServiceParameters - class net.openwings.component.UseServiceParameters.
This class defines an object which can be passed to the useService() methods of the ComponentComplex interface to specify configuration information and behavior relevant to using services.
UseServiceParameters() - Constructor for class net.openwings.component.UseServiceParameters
Default constructor
UseServiceParameters(UniqueID, UniqueID, boolean, boolean, boolean, Class, Object[], boolean, int, Attribute[]) - Constructor for class net.openwings.component.UseServiceParameters
General constructor
UseServicePolicy - interface net.openwings.component.UseServicePolicy.
This interface defines a policy which can be used to persist a UseServiceParameters() object that is intended to be passed to one of the ComponentComplex.useService() methods to specify configuration information and behavior relevant to using a service.
UserInterfaceBuilder - interface net.openwings.ui.UserInterfaceBuilder.
This interface describes a utility that can be used to obtain a user interface for a service or even an MBean
UserInterfaceBuilderFactory - class net.openwings.ui.UserInterfaceBuilderFactory.
This class provides a way to obtain an implementation of UserInterfaceBuilder.
UserInterfaceBuilderFactory() - Constructor for class net.openwings.ui.UserInterfaceBuilderFactory
 
UserInterfaceDescriptor - class net.openwings.component.utilities.UserInterfaceDescriptor.
This class is used to provide metadata about a user interface that is associated with a particular service.
UserInterfaceDescriptor() - Constructor for class net.openwings.component.utilities.UserInterfaceDescriptor
Default constructor (empty).
UserInterfaceDescriptor(Class, Class) - Constructor for class net.openwings.component.utilities.UserInterfaceDescriptor
This is the primary public constructor for the UserInterfaceDescriptor class.
UserInterfaceException - exception net.openwings.ui.UserInterfaceException.
This class defines an exception specific to using a UserInterfaceFactory.
UserInterfaceException() - Constructor for class net.openwings.ui.UserInterfaceException
Constructs a UserInterfaceException with no specified detail message.
UserInterfaceException(String) - Constructor for class net.openwings.ui.UserInterfaceException
Constructs a UserInterfaceException with the specified detail message.
UserInterfaceException(Exception, String) - Constructor for class net.openwings.ui.UserInterfaceException
Constructs a new UserInterfaceException.
UserInterfaceFactory - interface net.openwings.ui.UserInterfaceFactory.
This interface describes a factory that builds user interfaces for services.
UserInterfaceRepository - interface net.openwings.ui.UserInterfaceRepository.
This interface describes a service that holds user interface factory classes.
UserProxy - interface net.openwings.connector.synchronous.UserProxy.
This interface contains the methods that are to be implemented by a s service's user proxy.
undistributeObject(Class, Object) - Method in interface net.openwings.component.Component
This method is used to make an object unavailable remotely.
uninstallComponent(InstallableComponentDescriptor, boolean) - Method in interface net.openwings.install.Installer
This method is used to remove a Component from a platform.
units - Variable in class net.openwings.availability.PerformanceReport
This is the units of the measurement.
unpublishService(UniqueID) - Method in interface net.openwings.component.Component
This method is used to indicate that the component will no longer publish an asynchronous (event or messaging) service.
unregisterContainerProcessListener(ContainerProcessListener) - Method in interface net.openwings.container.Container
This method is used to cancel interest in receiving process status updates for every process in a container.
unregisterContainerProcessListener(ContainerProcessListener) - Method in interface net.openwings.container.ContainerProcess
This method is used to cancel interest in receiving process status updates from a ContainerProcess.
unregisterMobileProcessListener(MobileProcessListener) - Method in interface net.openwings.container.Container
This method is used to cancel interest in receiving the serialized state of processes in a container.
unregisterMobileProcessListener(MobileProcessListener) - Method in interface net.openwings.container.MobileProcess
This method is used to cancel interest in receiving the serialized state of a MobileProcess.
unregisterProcessAccess(ProcessAccess) - Method in interface net.openwings.container.ContainerAccess
This method is used by a process (an Openwings Component or other Java program) to cancel container access to process state.
unregisterProcessShutdown(ProcessShutdown) - Method in interface net.openwings.container.ContainerAccess
This method is used by a process (an Openwings Component or other Java program) to remove a shutdown callback.
unsubscribeService(UniqueID) - Method in interface net.openwings.component.Component
This method is used to stop subscription to a an asynchronous (event or messaging) service.
updatedPerformanceReports(PerformanceReport[]) - Method in interface net.openwings.container.ContainerAccess
This method is used by a process (an Openwings Component or other Java program) to push performance reports up to its container.
updatedProcessState(MarshalledObject) - Method in interface net.openwings.container.ContainerAccess
This method is used by a process (an Openwings Component or other Java program) to push its saved state up to its container.
useService(Class) - Method in interface net.openwings.component.Component
This method finds a synchronous (remote method) service provided by another component (lookup).
useService(Class, UseServiceListener) - Method in interface net.openwings.component.Component
This method registers for notification of synchronous (remote method) services provided other components (lookup).
useService(Class, UseServiceParameters) - Method in interface net.openwings.component.ComponentComplex
This method finds multiple synchronous (remote method) services provided by another component (lookup).
useService(Class, UseServiceListener, UseServiceParameters) - Method in interface net.openwings.component.ComponentComplex
This method registers for notification of synchronous (remote method) services provided other components (lookup).
userConnected() - Method in interface net.openwings.connector.synchronous.ConnectionListener
This method is called when a connection is established between the UserProxy and the ProviderProxy.
userDisconnected() - Method in interface net.openwings.connector.synchronous.ConnectionListener
This method is called when a connection is disconnected between the UserProxy and the ProviderProxy.

V

Visible - interface net.openwings.availability.Visible.
This class is used to encapsulate various methods for determining if a change in a connection's online/offline status.
VisibleFactory - class net.openwings.availability.VisibleFactory.
This class provides a way to obtain an implementation of Visible.
VisibleFactory() - Constructor for class net.openwings.availability.VisibleFactory
 
VisibleListener - interface net.openwings.availability.VisibleListener.
This interface describes a listener that may be registered with the Visible plugin to be notified of a change in a connection's online/offline status.
Voter - interface net.openwings.install.Voter.
This interface describes a callback that may be registered by components that wish to be consulted before a component is uninstalled.
validateLogin(String, String) - Method in interface net.openwings.security.SecurityService
This method is used to validate the user login.
visible(InetAddress) - Method in interface net.openwings.availability.VisibleListener
This method is called by the Visible implementation to notify the listener of a change in a connection's status from offline to online.
vote(InstallableComponentDescriptor) - Method in interface net.openwings.install.Voter
The Installer implementation invokes this method whenever a component uninstall is requested.

Y

YELLOW - Static variable in class net.openwings.availability.PerformanceReport
This constant is used to indicate a condition where there is a risk of performance availability fault.

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