Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

com::cosylab::acs::maci::ComponentInfo Class Reference

Collaboration diagram for com::cosylab::acs::maci::ComponentInfo:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 ComponentInfo (int handle, String name, String type, String code, Component component)
int getContainer ()
IntArray getClients ()
Component getComponent ()
int getHandle ()
String[] getInterfaces ()
String getName ()
String getType ()
String getCode ()
int getAccessRights ()
void setContainer (int container)
void setComponent (Component component)
void setHandle (int handle)
void setInterfaces (String[] interfaces)
void setName (String name)
void setType (String type)
void setCode (String code)
void setAccessRights (int accessRights)
void setClients (IntArray clients)
IntArray getComponents ()
void setComponents (IntArray components)
String getContainerName ()
void setContainerName (String containerName)
String toString ()
boolean isDynamic ()
void setDynamic (boolean b)
String getDynamicContainerName ()
void setDynamicContainerName (String string)
int getKeepAliveTime ()
void setKeepAliveTime (int keepAliveTime)
int compareTo (ComponentInfo o)

Private Attributes

int handle
String name
String type
String code
Component component
IntArray clients
IntArray components
int container
String containerName
int accessRights
String[] interfaces
boolean isDynamic
String dynamicContainerName
int keepAliveTime

Static Private Attributes

final long serialVersionUID = -4376414924118239593L

Detailed Description

Structure in which the Manager (and Container) stores information about a component.

Author:
Matej Sekoranja (matej.sekoranja@cosylab.com)
Version:
@VERSION@


Constructor & Destructor Documentation

com::cosylab::acs::maci::ComponentInfo::ComponentInfo int  handle,
String  name,
String  type,
String  code,
Component  component
[inline]
 

Creates an instance of ComponentInfo with all necesarry data.

Parameters:
handle handle of the component.
name name of the component.
type type of the component.
code code of the component.
component component itself.
See also:
handle

name

type

component


Member Function Documentation

int com::cosylab::acs::maci::ComponentInfo::compareTo ComponentInfo  o  )  [inline]
 

int com::cosylab::acs::maci::ComponentInfo::getAccessRights  )  [inline]
 

Returns the accessRights.

Returns:
int

IntArray com::cosylab::acs::maci::ComponentInfo::getClients  )  [inline]
 

Returns the clients.

Returns:
ArrayList

String com::cosylab::acs::maci::ComponentInfo::getCode  )  [inline]
 

Returns the code.

Returns:
String

Component com::cosylab::acs::maci::ComponentInfo::getComponent  )  [inline]
 

Returns the component.

Returns:
Component

IntArray com::cosylab::acs::maci::ComponentInfo::getComponents  )  [inline]
 

Get array of component handles that this component requested.

Returns:
array of component handles that this component requested.

int com::cosylab::acs::maci::ComponentInfo::getContainer  )  [inline]
 

Returns the container.

Returns:
int

String com::cosylab::acs::maci::ComponentInfo::getContainerName  )  [inline]
 

Get container name which hosts the component.

Returns:
Returns the container name.

String com::cosylab::acs::maci::ComponentInfo::getDynamicContainerName  )  [inline]
 

Get container on which dynamic component was activated.

Returns:
container on which dynamic component was activated.

int com::cosylab::acs::maci::ComponentInfo::getHandle  )  [inline]
 

Returns the handle.

Returns:
int

String [] com::cosylab::acs::maci::ComponentInfo::getInterfaces  )  [inline]
 

Returns the interfaces.

Returns:
String[]

int com::cosylab::acs::maci::ComponentInfo::getKeepAliveTime  )  [inline]
 

Get component keep alive time.

Returns:
component keep alive time.

String com::cosylab::acs::maci::ComponentInfo::getName  )  [inline]
 

Returns the name.

Returns:
String

String com::cosylab::acs::maci::ComponentInfo::getType  )  [inline]
 

Returns the type.

Returns:
String

boolean com::cosylab::acs::maci::ComponentInfo::isDynamic  )  [inline]
 

Get dynamic flag.

Returns:
dynamic flag.

void com::cosylab::acs::maci::ComponentInfo::setAccessRights int  accessRights  )  [inline]
 

Sets the access rights.

Parameters:
accessRights The access rights to set

void com::cosylab::acs::maci::ComponentInfo::setClients IntArray  clients  )  [inline]
 

Sets the clients.

Parameters:
clients The clients to set

void com::cosylab::acs::maci::ComponentInfo::setCode String  code  )  [inline]
 

Sets the code.

Parameters:
code The code to set

void com::cosylab::acs::maci::ComponentInfo::setComponent Component  component  )  [inline]
 

Sets the component.

Parameters:
component The component to set

void com::cosylab::acs::maci::ComponentInfo::setComponents IntArray  components  )  [inline]
 

Sets the components.

Parameters:
components The components to set

void com::cosylab::acs::maci::ComponentInfo::setContainer int  container  )  [inline]
 

Sets the container.

Parameters:
container The container to set

void com::cosylab::acs::maci::ComponentInfo::setContainerName String  containerName  )  [inline]
 

Set container name.

Parameters:
containerName The container name to set.

void com::cosylab::acs::maci::ComponentInfo::setDynamic boolean  b  )  [inline]
 

Set dynamic flag.

Parameters:
b dynamic flag.

void com::cosylab::acs::maci::ComponentInfo::setDynamicContainerName String  string  )  [inline]
 

Set container on which dynamic component was activated.

Parameters:
string container on which dynamic component was activated.

void com::cosylab::acs::maci::ComponentInfo::setHandle int  handle  )  [inline]
 

Sets the handle.

Parameters:
handle The handle to set

void com::cosylab::acs::maci::ComponentInfo::setInterfaces String[]  interfaces  )  [inline]
 

Sets the interfaces.

Parameters:
interfaces The interfaces to set

void com::cosylab::acs::maci::ComponentInfo::setKeepAliveTime int  keepAliveTime  )  [inline]
 

Set component keep alive time.

Parameters:
keepAliveTime the keepAliveTime to set.

void com::cosylab::acs::maci::ComponentInfo::setName String  name  )  [inline]
 

Sets the name.

Parameters:
name The name to set

void com::cosylab::acs::maci::ComponentInfo::setType String  type  )  [inline]
 

Sets the type.

Parameters:
type The type to set

String com::cosylab::acs::maci::ComponentInfo::toString  )  [inline]
 

Returns a single-line rendition of this instance into text.

Returns:
internal state of this instance


Member Data Documentation

int com::cosylab::acs::maci::ComponentInfo::accessRights [private]
 

Required access rights to access this component. When a client attempts to access the component (via Manager's get_component), the bitwise AND of client's access and component's access must yield component's access in order for the client to have the permission to access the component.

IntArray com::cosylab::acs::maci::ComponentInfo::clients [private]
 

Specifies the clients that have requested and successfuly obtained a reference to this component from the Manager. If a client has done so more than once, its handle is not repeated. For immortal and startup components this list always contains at least one handle - the Manager. Thus, the only way to deactivate these components is by deactivating the Manager.

String com::cosylab::acs::maci::ComponentInfo::code [private]
 

The code of the component. Path to the executable file (a DLL, a shared library, or Java class name) in which the component's code resides. Can be null, if unknown.

Component com::cosylab::acs::maci::ComponentInfo::component [private]
 

Reference to the component, null if the component has not yet been activated.

IntArray com::cosylab::acs::maci::ComponentInfo::components [private]
 

Specifies the components that have been requested and successfuly obtained a reference by this component from the Manager. If a component has done so more than once, its handle is not repeated.

int com::cosylab::acs::maci::ComponentInfo::container [private]
 

Handle to the container which hosts the component. This handle is 0 if the component has not been activated by an component, but by some other means, and has only been registered with the Manager through register_component.

String com::cosylab::acs::maci::ComponentInfo::containerName [private]
 

Name of the container which hosts the component.

String com::cosylab::acs::maci::ComponentInfo::dynamicContainerName [private]
 

Name of the container on which dynamic component was activated. NOTE: this attribute is internal.

int com::cosylab::acs::maci::ComponentInfo::handle [private]
 

Component's handle. The handle is automatically assigned by the Manager.

String [] com::cosylab::acs::maci::ComponentInfo::interfaces [private]
 

A list of all interfaces supported by the component. The first interface in the list is the default interface.

boolean com::cosylab::acs::maci::ComponentInfo::isDynamic [private]
 

Dynamic component flag. NOTE: this attribute is internal.

int com::cosylab::acs::maci::ComponentInfo::keepAliveTime [private]
 

Keep alive time of a component (needed for dynamic components). NOTE: this attribute is internal.

String com::cosylab::acs::maci::ComponentInfo::name [private]
 

Name of the component (without the domain). The name of the component must be unique within the domain, and can be used to identify the component. The name can imply hierarchy, which it does by separating name components with a '/' (slash).

final long com::cosylab::acs::maci::ComponentInfo::serialVersionUID = -4376414924118239593L [static, private]
 

Serial version UID.

String com::cosylab::acs::maci::ComponentInfo::type [private]
 

The type of the component. Uniquely identifies the code-base which the component's servant is executing. Given the type name and a hypothetical type library it is possible to infer supported interfaces, version information, etc.


The documentation for this class was generated from the following file:
Generated on Thu Apr 30 03:11:14 2009 for ACS Java API by doxygen 1.3.8