ActivityContext (Policy Manager API)

```
public interface ActivityContext
```
Provides the context in which an activity is performed.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`java.lang.String`	`getActivityName()` Returns the name of the activity.
`Logger`	`getAuditLogger()` Provides audit logging capabilities.
`Exchange`	`getCreatingExchange()` Returns the message exchange implementing the operation invocation for which the activity is performed.
`javax.xml.namespace.QName`	`getInterface()` Returns the interface name of the service for which the activity is performed.
`Message`	`getMessage()` Returns the message that is the subject of the activity.
`java.lang.String`	`getOperation()` Returns the name of the operation for which the activity is performed.
`java.lang.String`	`getProcessId()` Returns the unique ID of the running process that is executing the activity.
`javax.xml.namespace.QName`	`getService()` Returns the name of the service for which the activity is performed.
`javax.security.auth.Subject`	`getSubject(java.lang.String category)` Returns the Subject with the given subject category.
`java.util.Set<java.lang.String>`	`getSubjectCategories()` Returns the categories of subjects associated with the process.
`java.lang.Object`	`getVariable(java.lang.String name)` Returns the value of the variable with the given name.
`java.util.List<java.lang.String>`	`getVariableNames()` Returns the names of the variables in the context of the process.
`void`	`setFault(Message fault)` Changes the fault message returned by an activity (if any).
`void`	`setFaultName(java.lang.String faultName)` Changes the name of the fault message returned by an activity (if any).
`void`	`setSubject(java.lang.String category, javax.security.auth.Subject subject)` Adds or replaces the Subject with the given subject category.
`void`	`setVariable(java.lang.String name, java.lang.Object value)` Adds or changes the value of the variable with the given name.

- Method Detail
  - getActivityName
```
java.lang.String getActivityName()
```
    Returns the name of the activity.
    
    Returns:
    
    Name of the activity.
  - getProcessId
```
java.lang.String getProcessId()
```
    Returns the unique ID of the running process that is executing the activity.
    
    Returns:
    
    Unique ID of the running process that is executing the activity.
  - getService
```
javax.xml.namespace.QName getService()
```
    Returns the name of the service for which the activity is performed.
    
    Returns:
    
    QName of the service for which the activity is performed.
  - getInterface
```
javax.xml.namespace.QName getInterface()
```
    Returns the interface name of the service for which the activity is performed.
    
    Returns:
    
    Interface QName of the service for which the activity is performed.
  - getOperation
```
java.lang.String getOperation()
```
    Returns the name of the operation for which the activity is performed.
    
    Returns:
    
    QName of the operation for which the activity is performed.
  - getCreatingExchange
```
Exchange getCreatingExchange()
```
    Returns the message exchange implementing the operation invocation for which the activity is performed. Note, if the activity would like to change the content of a message in the message exchange it should not use the messages in this exchange directly, but use the getMessage() method of this context.
    
    Returns:
    
    Exchange implementing the operation invocation for which the activity is performed.
  - getMessage
```
Message getMessage()
```
    Returns the message that is the subject of the activity. Depending on where in the process the activity is being performed it may be the input message of the message exchange or the output. The message may or may not be the same message found in the creating message exchange.
    
    Returns:
    
    Message that is the subject of the activity.
  - getVariableNames
```
java.util.List<java.lang.String> getVariableNames()
```
    Returns the names of the variables in the context of the process. Changes to the list will not result in changes to the real variables. New or removed variables after calling this method will not be reflected in this list without making another call.
    
    Returns:
    
    List of variable names.
  - getVariable
```
java.lang.Object getVariable(java.lang.String name)
```
    Returns the value of the variable with the given name.
    
    Parameters:
    
    name - Name of the variable.
    
    Returns:
    
    Variable value, null if none found with that name.
  - setVariable
```
void setVariable(java.lang.String name,
                 java.lang.Object value)
```
    Adds or changes the value of the variable with the given name.
    
    Parameters:
    
    name - Name of the variable.
    
    value - New value of the variable.
  - getSubjectCategories
```
java.util.Set<java.lang.String> getSubjectCategories()
```
    Returns the categories of subjects associated with the process.
    
    Returns:
    
    Set of subject categories, may be null if none found.
  - getSubject
```
javax.security.auth.Subject getSubject(java.lang.String category)
```
    Returns the Subject with the given subject category.
    
    Parameters:
    
    category - Category of the subject to return.
    
    Returns:
    
    Subject with the given category, null if none found.
  - setSubject
```
void setSubject(java.lang.String category,
                javax.security.auth.Subject subject)
```
    Adds or replaces the Subject with the given subject category.
    
    Parameters:
    
    category - Category of the subject.
    
    subject - Subject to add/replace.
  - setFault
```
void setFault(Message fault)
```
    Changes the fault message returned by an activity (if any).
    
    Parameters:
    
    fault - Fault object holding the fault returned by an activity, null if none returned.
  - setFaultName
```
void setFaultName(java.lang.String faultName)
```
    Changes the name of the fault message returned by an activity (if any).
    
    Parameters:
    
    faultName - Name of the fault message, null if none returned.
  - getAuditLogger
```
Logger getAuditLogger()
```
    Provides audit logging capabilities. This is different than the system logging capabilities provided by com.soa.log.Logger. The audit log statements are governed by and viewed in the management application. Each log statement has a different level of importance or purpose, debug, warning, or error in that order. These statements will only be seen in the log if the handler is invoked with a level equal to or greater than that statement.
    
    Returns:
    
    Logger.

This software is the confidential and proprietary information of Perforce, Inc. and is subject to copyright protection under laws of the United States of America and other countries. The use of this software should be in accordance with the license agreement terms you entered into with Perforce, Inc.

Interface ActivityContext

Method Summary

Method Detail

getActivityName

getProcessId

getService

getInterface

getOperation

getCreatingExchange

getMessage

getVariableNames

getVariable

setVariable

getSubjectCategories

getSubject

setSubject

setFault

setFaultName

getAuditLogger