VistaKernelPrincipal (gov.va.med.vistalink

All Superinterfaces:

Principal

All Known Implementing Classes:

VistaKernelPrincipalImpl
```
public interface VistaKernelPrincipal
extends Principal
```
Provides an interface to marks a principal that represents a logged on Kernel user on an M system. Upon a successful JAAS login, one or more principals may be contained in the JAAS subject that is returned from a successful JAAS login (only one *Kernel* principal should be returned, however. The situation in which multiple principals could be returned is if some kind of compound logon has been set up that requires several logons to complete, for example one to Kernel, and one to a separate health data repository). The VistaKernelPrincipal interface is a marker you can use to identify a "VistaKernelPrincipal" as one of those principals. However, an easier approach is to use the helper method getKernelPrincipal in VistaKernelPrincipalImpl to directly retrieve the single VistaKernelPrincipal.
You can use the KEY* field strings to retrieve user demographics values via the getUserDemographicValue method. For example:
private VistaKernelPrincipalImpl userPrincipal;
// left out: perform a login... then the subject in the logincontext is populated
// get the Kernel principal after successful login userPrincipal = VistaKernelPrincipalImpl.getKernelPrincipal(loginContext.getSubject());
// get user demographics String duz = this.userPrincipal.getUserDemographicValue(VistaKernelPrincipalImpl.KEY_DUZ); String name = userPrincipal.getUserDemographicValue(VistaKernelPrincipalImpl.KEY_NAME_DISPLAY);

See Also:

VistaKernelPrincipalImpl

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`KEY_DIVISION_IEN` map key to store/retrieve division station IEN from userDemographicsHashTable
`static String`	`KEY_DIVISION_STATION_NAME` map key to store/retrieve division station name from userDemographicsHashTable
`static String`	`KEY_DIVISION_STATION_NUMBER` map key to store/retrieve division station number from userDemographicsHashTable
`static String`	`KEY_DOMAIN_NAME` map key to store/retrieve domain name from userDemographicHashTable
`static String`	`KEY_DTIME` map key to store/retrieve user timeout value from userDemographicsHashTable
`static String`	`KEY_DUZ` map key to store/retrieve DUZ from userDemographicsHashTable
`static String`	`KEY_LANGUAGE` map key to store/retrieve user language from userDemographicsHashTable
`static String`	`KEY_NAME_DEGREE` map key to store/retrieve degree from userDemographicsHashTable
`static String`	`KEY_NAME_DISPLAY` map key to store/retrieve the display name from userDemographicsHashTable
`static String`	`KEY_NAME_FAMILYLAST` map key to store/retrieve name component family-last from userDemographicsHashTable
`static String`	`KEY_NAME_GIVENFIRST` map key to store/retrieve name component given-first from userDemographicsHashTable
`static String`	`KEY_NAME_MIDDLE` map key to store/retrieve name component middle from userDemographicsHashTable
`static String`	`KEY_NAME_NEWPERSON01` map key to store/retrieve New Person .01 Field name from userDemographicsHashTable
`static String`	`KEY_NAME_PREFIX` map key to store/retrieve name component prefix from userDemographicsHashTable
`static String`	`KEY_NAME_SUFFIX` map key to store/retrieve name component suffix from userDemographicsHashTable
`static String`	`KEY_SERVICE_SECTION` map key to store/retrieve user service/section from userDemographicsHashTable
`static String`	`KEY_TITLE` map key to store/retrieve user title from userDemographicsHashTable
`static String`	`KEY_VPID` map key to store/retrieve user VPID from userDemographicHashTable

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)` Returns whether some object equals this one.
`String`	`getName()` returns the name given to the principal when it was created.
`String`	`getUserDemographicValue(String key)` returns a given user demographic value.
`String`	`toString()` A string representation of the principal

Methods inherited from interface Principal
hashCode, implies

- Field Detail
  - KEY_NAME_NEWPERSON01
```
static final String KEY_NAME_NEWPERSON01
```
    map key to store/retrieve New Person .01 Field name from userDemographicsHashTable
    
    See Also:
    
    Constant Field Values
  - KEY_NAME_DISPLAY
```
static final String KEY_NAME_DISPLAY
```
    map key to store/retrieve the display name from userDemographicsHashTable
    
    See Also:
    
    Constant Field Values
  - KEY_NAME_PREFIX
```
static final String KEY_NAME_PREFIX
```
    map key to store/retrieve name component prefix from userDemographicsHashTable
    
    See Also:
    
    Constant Field Values
  - KEY_NAME_SUFFIX
```
static final String KEY_NAME_SUFFIX
```
    map key to store/retrieve name component suffix from userDemographicsHashTable
    
    See Also:
    
    Constant Field Values
  - KEY_NAME_GIVENFIRST
```
static final String KEY_NAME_GIVENFIRST
```
    map key to store/retrieve name component given-first from userDemographicsHashTable
    
    See Also:
    
    Constant Field Values
  - KEY_NAME_MIDDLE
```
static final String KEY_NAME_MIDDLE
```
    map key to store/retrieve name component middle from userDemographicsHashTable
    
    See Also:
    
    Constant Field Values
  - KEY_NAME_FAMILYLAST
```
static final String KEY_NAME_FAMILYLAST
```
    map key to store/retrieve name component family-last from userDemographicsHashTable
    
    See Also:
    
    Constant Field Values
  - KEY_NAME_DEGREE
```
static final String KEY_NAME_DEGREE
```
    map key to store/retrieve degree from userDemographicsHashTable
    
    See Also:
    
    Constant Field Values
  - KEY_DUZ
```
static final String KEY_DUZ
```
    map key to store/retrieve DUZ from userDemographicsHashTable
    
    See Also:
    
    Constant Field Values
  - KEY_TITLE
```
static final String KEY_TITLE
```
    map key to store/retrieve user title from userDemographicsHashTable
    
    See Also:
    
    Constant Field Values
  - KEY_SERVICE_SECTION
```
static final String KEY_SERVICE_SECTION
```
    map key to store/retrieve user service/section from userDemographicsHashTable
    
    See Also:
    
    Constant Field Values
  - KEY_LANGUAGE
```
static final String KEY_LANGUAGE
```
    map key to store/retrieve user language from userDemographicsHashTable
    
    See Also:
    
    Constant Field Values
  - KEY_DIVISION_IEN
```
static final String KEY_DIVISION_IEN
```
    map key to store/retrieve division station IEN from userDemographicsHashTable
    
    See Also:
    
    Constant Field Values
  - KEY_DIVISION_STATION_NAME
```
static final String KEY_DIVISION_STATION_NAME
```
    map key to store/retrieve division station name from userDemographicsHashTable
    
    See Also:
    
    Constant Field Values
  - KEY_DIVISION_STATION_NUMBER
```
static final String KEY_DIVISION_STATION_NUMBER
```
    map key to store/retrieve division station number from userDemographicsHashTable
    
    See Also:
    
    Constant Field Values
  - KEY_DTIME
```
static final String KEY_DTIME
```
    map key to store/retrieve user timeout value from userDemographicsHashTable
    
    See Also:
    
    Constant Field Values
  - KEY_VPID
```
static final String KEY_VPID
```
    map key to store/retrieve user VPID from userDemographicHashTable
    
    See Also:
    
    Constant Field Values
  - KEY_DOMAIN_NAME
```
static final String KEY_DOMAIN_NAME
```
    map key to store/retrieve domain name from userDemographicHashTable
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getName
```
String getName()
```
    returns the name given to the principal when it was created.
    
    Specified by:
    
    getName in interface Principal
    
    See Also:
    
    Principal.getName()
  - getUserDemographicValue
```
String getUserDemographicValue(String key)
```
    returns a given user demographic value. Use the various KEY* field strings to retrieve various values.
    
    Parameters:
    
    key - The key under which the demographic value is stored
    
    Returns:
    
    String the value of the demographic value requests
  - toString
```
String toString()
```
    A string representation of the principal
    
    Specified by:
    
    toString in interface Principal
    
    Overrides:
    
    toString in class Object
    
    See Also:
    
    Principal.toString()
  - equals
```
boolean equals(Object o)
```
    Returns whether some object equals this one. Because of the nature of a principal and an authenticated connection, we never can call two principals "equal" unless the object reference is to the same object. Otherwise its unfathomable whether the two connections held by the principals are "equal". So false is returned in all instances except where the object references are to the same object.
    
    Specified by:
    
    equals in interface Principal
    
    Overrides:
    
    equals in class Object
    
    See Also:
    
    Principal.equals(Object)

Interface VistaKernelPrincipal

Field Summary

Method Summary

Methods inherited from interface Principal

Field Detail

KEY_NAME_NEWPERSON01

KEY_NAME_DISPLAY

KEY_NAME_PREFIX

KEY_NAME_SUFFIX

KEY_NAME_GIVENFIRST

KEY_NAME_MIDDLE

KEY_NAME_FAMILYLAST

KEY_NAME_DEGREE

KEY_DUZ

KEY_TITLE

KEY_SERVICE_SECTION

KEY_LANGUAGE

KEY_DIVISION_IEN

KEY_DIVISION_STATION_NAME

KEY_DIVISION_STATION_NUMBER

KEY_DTIME

KEY_VPID

KEY_DOMAIN_NAME

Method Detail

getName

getUserDemographicValue

toString

equals