org.arm4.arm40.transaction
Class ArmApplication

java.lang.Object
  extended by org.arm4.arm40.transaction.ArmInterface
      extended by org.arm4.arm40.transaction.ArmApplication
All Implemented Interfaces:
ArmApplication, ArmInterface
Direct Known Subclasses:
ArmApplicationRemote

public class ArmApplication
extends ArmInterface
implements ArmApplication

ArmApplication represents an instance of an executing application. It provides an anchor point for associating ArmTransaction objects with the application instance. Instances of ArmApplication are created using the newArmApplication() method of ArmTransactionFactory.

Version:
$Revision$ $Date$
Author:
dcarter

Field Summary
protected  ArmApplicationDefinition m_appDefinition
           
protected  long m_appHandle
           
protected  java.lang.String m_group
           
protected  java.lang.String m_instance
           
protected  ArmIdentityProperties m_properties
           
protected  ArmSystemAddress m_systemAddress
           
 
Fields inherited from class org.arm4.arm40.transaction.ArmInterface
m_errorCode, m_factory
 
Constructor Summary
  ArmApplication(ArmApplicationDefinition definition, java.lang.String group, java.lang.String instance, java.lang.String[] contextValues, ArmFactory factory)
          Create the ARM Application.
protected ArmApplication(ArmApplicationDefinition definition, java.lang.String group, java.lang.String instance, java.lang.String[] contextValues, ArmSystemAddress address, ArmFactory factory)
          Create the ARM Application.
 
Method Summary
 int end()
          indicates that the application instance has halted.
 long getApplicationHandle()
          Get the application handle.
 java.lang.String getContextValue(int index)
          retrieves a context property value.
 ArmApplicationDefinition getDefinition()
           
 java.lang.String getGroup()
           
 java.lang.String getInstance()
           
 ArmSystemAddress getSystemAddress()
          Get the system address when this is part of a transaction report.
 
Methods inherited from class org.arm4.arm40.transaction.ArmInterface
getErrorCode, getErrorMessage, getFactory, setErrorCode, setFactory
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.opengroup.arm40.transaction.ArmInterface
getErrorCode, getErrorMessage, setErrorCode
 

Field Detail

m_appDefinition

protected ArmApplicationDefinition m_appDefinition

m_properties

protected ArmIdentityProperties m_properties

m_systemAddress

protected ArmSystemAddress m_systemAddress

m_group

protected java.lang.String m_group

m_instance

protected java.lang.String m_instance

m_appHandle

protected long m_appHandle
Constructor Detail

ArmApplication

public ArmApplication(ArmApplicationDefinition definition,
                      java.lang.String group,
                      java.lang.String instance,
                      java.lang.String[] contextValues,
                      ArmFactory factory)
Create the ARM Application.

Parameters:
definition -
group -
instance -
contextValues -
factory -

ArmApplication

protected ArmApplication(ArmApplicationDefinition definition,
                         java.lang.String group,
                         java.lang.String instance,
                         java.lang.String[] contextValues,
                         ArmSystemAddress address,
                         ArmFactory factory)
Create the ARM Application.

Parameters:
definition -
group -
instance -
contextValues -
address -
factory -
Method Detail

end

public int end()
Description copied from interface: ArmApplication
indicates that the application instance has halted. See comments in the interface description above.

Specified by:
end in interface ArmApplication
Returns:
0 on sucess; otherwise, a non-zero error code is returned (as specified in ArmInterface).

getContextValue

public java.lang.String getContextValue(int index)
Description copied from interface: ArmApplication
retrieves a context property value.

Specified by:
getContextValue in interface ArmApplication
Parameters:
index - the index into the context properties array.
Returns:
The context value at the specified index, or null. See comments in the interface description above.

getDefinition

public ArmApplicationDefinition getDefinition()
Specified by:
getDefinition in interface ArmApplication
Returns:
the metadata describing this application.

getGroup

public java.lang.String getGroup()
Specified by:
getGroup in interface ArmApplication
Returns:
the group name this application is associated with, or null. See comments in the interface description above.

getInstance

public java.lang.String getInstance()
Specified by:
getInstance in interface ArmApplication
Returns:
the instance name attributed to this application, or null. See comments in the interface description above.

getSystemAddress

public ArmSystemAddress getSystemAddress()
Get the system address when this is part of a transaction report.

Returns:

getApplicationHandle

public long getApplicationHandle()
Get the application handle.

Returns: