All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.ibm.as400.security.auth.UserProfilePrincipal

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

public class UserProfilePrincipal
extends AS400Principal
implements AS400BasicAuthenticationPrincipal
The UserProfilePrincipal class represents an AS/400 user profile.

See Also:
AS400Principal

Constructor Index

 o UserProfilePrincipal()
Constructs a UserProfilePrincipal object.
 o UserProfilePrincipal(AS400, String)
Constructs a UserProfilePrincipal object.

Method Index

 o equals(Object)
Compares the specified Object with the credential for equality.
 o getUserProfileName()
Returns the user profile name.
 o hashCode()
Returns a hash code for this principal.
 o initialize(String)
Initializes a principal for the local AS/400 system based on the given user profile name.
 o setUserProfileName(String)
Sets the user profile name.
 o toString()
Returns a string representation of the object

Constructors

 o UserProfilePrincipal
 public UserProfilePrincipal()
Constructs a UserProfilePrincipal object.

 o UserProfilePrincipal
 public UserProfilePrincipal(AS400 system,
                             String name)
Constructs a UserProfilePrincipal object.

The system and name properties are set to the specified values.

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

Methods

 o equals
 public boolean equals(Object o)
Compares the specified Object with the credential for equality.

Parameters:
o - Object to be compared for equality.
Returns:
true if equal; otherwise false.
Overrides:
equals in class Object
 o getUserProfileName
 public String getUserProfileName()
Returns the user profile name.

Returns:
A String containing the name; empty if not assigned.
Overrides:
getUserProfileName in class AS400Principal
 o hashCode
 public int hashCode()
Returns a hash code for this principal.

Returns:
a hash code for this principal.
Overrides:
hashCode in class Object
 o initialize
 public void initialize(String name) throws Exception
Initializes a principal for the local AS/400 system based on the given user profile name.

Parameters:
name - The profile name.
Throws: Exception
If an exception occurs.
 o setUserProfileName
 public void setUserProfileName(String name) throws PropertyVetoException
Sets the user profile name.

Parameters:
name - The profile name.
Throws: PropertyVetoException
If the change is vetoed.
Throws: ExtendedIllegalArgumentException
If the provided value exceeds the maximum allowed length or contains non-valid characters.
 o toString
 public String toString()
Returns a string representation of the object

Returns:
a string representation of the object.
Overrides:
toString in class Object

All Packages  Class Hierarchy  This Package  Previous  Next  Index