All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.ibm.as400.security.auth.AS400Principal

java.lang.Object
   |
   +----com.ibm.as400.security.auth.AS400Principal

public abstract class AS400Principal
extends Object
implements Principal, Serializable
The AS400Principal class provides an abstract superclass for representations of AS/400 security-related identities.

Typical AS/400 Principals include, but are not necessarily limited to, user profiles.


Constructor Index

 o AS400Principal()
Constructs an AS400Principal object.
 o AS400Principal(AS400)
Constructs an AS400Principal object.

Method Index

 o addPropertyChangeListener(PropertyChangeListener)
Adds a PropertyChangeListener.
 o addVetoableChangeListener(VetoableChangeListener)
Adds a VetoableChangeListener.
 o getName()
Returns the name commonly used to refer to the principal.
 o getSystem()
Returns the AS400 system object for the principal.
 o getUser()
Returns an AS/400 User object based on the user profile name and system associated with the principal.
 o getUserProfileName()
Returns the name of a user profile associated with the OS/400 thread when work is performed on behalf of the principal.
 o removePropertyChangeListener(PropertyChangeListener)
Removes the specified listener from the internal list.
 o removeVetoableChangeListener(VetoableChangeListener)
Removes the specified listener from the internal list.
 o setSystem(AS400)
Sets the AS400 system object for the principal.

Constructors

 o AS400Principal
 public AS400Principal()
Constructs an AS400Principal object.

 o AS400Principal
 public AS400Principal(AS400 system)
Constructs an AS400Principal object.

The system property is set to the specified value.

Parameters:
system - The AS/400 associated with the principal.

Methods

 o addPropertyChangeListener
 public void addPropertyChangeListener(PropertyChangeListener listener)
Adds a PropertyChangeListener.

The specified listener's propertyChange method will be called each time the value of a bound property is changed.

Parameters:
listener - The PropertyChangeListener.
See Also:
removePropertyChangeListener
 o addVetoableChangeListener
 public void addVetoableChangeListener(VetoableChangeListener listener)
Adds a VetoableChangeListener.

The specified listener's vetoableChange method will be called each time the value of a constrained property is changed.

Parameters:
listener - The VetoableChangeListener.
See Also:
removeVetoableChangeListener
 o getName
 public String getName()
Returns the name commonly used to refer to the principal.

Default behavior for the superclass is to return the user profile name

Returns:
The principal's name.
 o getSystem
 public AS400 getSystem()
Returns the AS400 system object for the principal.

Returns:
The AS400 system for the principal; null if not assigned.
 o getUser
 public User getUser() throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, ObjectDoesNotExistException, IOException, UnsupportedEncodingException
Returns an AS/400 User object based on the user profile name and system associated with the principal.

The system property must be set and a valid userProfileName must be identified by the principal prior to requesting the user.

Returns:
The com.ibm.as400.access.User object.
Throws: ExtendedIllegalStateException
If a required property is not set.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
 o getUserProfileName
 public String getUserProfileName()
Returns the name of a user profile associated with the OS/400 thread when work is performed on behalf of the principal.

Returns:
A String containing the name; empty if not applicable.
 o removePropertyChangeListener
 public void removePropertyChangeListener(PropertyChangeListener listener)
Removes the specified listener from the internal list.

Does nothing if the listener is not in the list.

Parameters:
listener - The PropertyChangeListener.
See Also:
addPropertyChangeListener
 o removeVetoableChangeListener
 public void removeVetoableChangeListener(VetoableChangeListener listener)
Removes the specified listener from the internal list.

Does nothing if the listener is not in the list.

Parameters:
listener - The VetoableChangeListener.
See Also:
addVetoableChangeListener
 o setSystem
 public void setSystem(AS400 system) throws PropertyVetoException
Sets the AS400 system object for the principal.

Parameters:
system - The AS400 system object.
Throws: PropertyVetoException
If the change is vetoed.

All Packages  Class Hierarchy  This Package  Previous  Next  Index