org.arm4.arm40.transaction
Class ArmIdentityProperties

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

public class ArmIdentityProperties
extends ArmInterface
implements ArmIdentityProperties

ArmIdentityProperties addresses a requirement to accept a set of string name=value pairs that extend the concept of application and transaction identity and context. An identity property's name and value are the same for all instances of an application or transaction. A context property's name is the same for all instances of an application or transaction, but a context property's value may vary for each instance and the values are defined in ArmApplication and ArmTransaction. ArmIdentityProperties is created with the newArmIdentityProperties() method of ArmTransactionFactory.

Version:
$Revision$ $Date$
Author:
dcarter

Field Summary
protected  java.util.ArrayList m_contextProperties
           
protected  java.util.ArrayList m_identityProperties
           
 
Fields inherited from class org.arm4.arm40.transaction.ArmInterface
m_errorCode, m_factory
 
Constructor Summary
ArmIdentityProperties(ArmIdentityProperties identityProperties)
          Create the ARM Identity Properties.
ArmIdentityProperties(java.lang.String[] identity_names, java.lang.String[] identity_values, java.lang.String[] context_names, ArmFactory factory)
          Create the ARM Identity Properties.
 
Method Summary
 java.lang.String getContextName(int index)
           
 java.lang.String[] getContextNames()
          Returns an array of all the ARM Context Names.
 java.lang.String getContextValue(int index)
          Returns the ARM Context Value at the given index.
 java.lang.String[] getContextValues()
          Returns an array of all the ARM Context Values.
 java.lang.String getIdentityName(int index)
           
 java.lang.String[] getIdentityNames()
          Returns an array of all the ARM Identity Names.
 java.lang.String getIdentityValue(int index)
           
 java.lang.String[] getIdentityValues()
          Returns an array of all the ARM Identity Values.
 void setContextValue(int index, java.lang.String value)
          Set the Context value at the given index.
 void setContextValues(java.lang.String[] values)
          Set all the context values to the given list.
 
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_identityProperties

protected java.util.ArrayList m_identityProperties

m_contextProperties

protected java.util.ArrayList m_contextProperties
Constructor Detail

ArmIdentityProperties

public ArmIdentityProperties(java.lang.String[] identity_names,
                             java.lang.String[] identity_values,
                             java.lang.String[] context_names,
                             ArmFactory factory)
Create the ARM Identity Properties.

Parameters:
identity_names -
identity_values -
context_names -
factory -

ArmIdentityProperties

public ArmIdentityProperties(ArmIdentityProperties identityProperties)
Create the ARM Identity Properties.

Parameters:
identityProperties -
Method Detail

getIdentityName

public java.lang.String getIdentityName(int index)
Specified by:
getIdentityName in interface ArmIdentityProperties
Parameters:
index - the index of the identity name to be returned.
Returns:
the string (the name part of the (name,value) identity property) at the specified array index. The returned value will be null if either the name or value at the index is set to null.

getIdentityNames

public java.lang.String[] getIdentityNames()
Returns an array of all the ARM Identity Names.

Returns:
an array of all the ARM Identity Names.

getIdentityValue

public java.lang.String getIdentityValue(int index)
Specified by:
getIdentityValue in interface ArmIdentityProperties
Parameters:
index - the index of the identity value to be returned.
Returns:
the string (the value part of the (name,value) identity property) at the specified array index. The returned value will be null if either the name or value at the index is set to null.

getIdentityValues

public java.lang.String[] getIdentityValues()
Returns an array of all the ARM Identity Values.

Returns:
an array of all the ARM Identity Values.

getContextName

public java.lang.String getContextName(int index)
Specified by:
getContextName in interface ArmIdentityProperties
Parameters:
index - the index of the context name to be returned.
Returns:
the string (the name part of the (name,value) context property) at the specified array index. The returned value may be null.

getContextNames

public java.lang.String[] getContextNames()
Returns an array of all the ARM Context Names.

Returns:
an array of all the ARM Context Names.

getContextValue

public java.lang.String getContextValue(int index)
Returns the ARM Context Value at the given index.

Parameters:
index -
Returns:
the ARM Context Value at the given index.

getContextValues

public java.lang.String[] getContextValues()
Returns an array of all the ARM Context Values.

Returns:
an array of all the ARM Context Values.

setContextValue

public void setContextValue(int index,
                            java.lang.String value)
Set the Context value at the given index.

Parameters:
index -
value -

setContextValues

public void setContextValues(java.lang.String[] values)
Set all the context values to the given list.

Parameters:
values -