com.ibm.as400.security.auth
Class UserProfilePrincipal
- java.lang.Object
-
- com.ibm.as400.security.auth.AS400Principal
-
- com.ibm.as400.security.auth.UserProfilePrincipal
-
- All Implemented Interfaces:
- AS400BasicAuthenticationPrincipal, java.io.Serializable, java.security.Principal
public class UserProfilePrincipal extends AS400Principal implements AS400BasicAuthenticationPrincipal
The UserProfilePrincipal class represents an IBM i system user profile.- See Also:
AS400Principal
, Serialized Form
-
-
Constructor Summary
Constructors Constructor and Description UserProfilePrincipal()
Constructs a UserProfilePrincipal object.UserProfilePrincipal(AS400 system, java.lang.String name)
Constructs a UserProfilePrincipal object.UserProfilePrincipal(java.lang.String name)
Constructs a UserProfilePrincipal object with the principal name set to the supplied argument.
-
Method Summary
Methods Modifier and Type Method and Description boolean
equals(java.lang.Object o)
Compares the specified Object with the credential for equality.java.lang.String
getUserProfileName()
Returns the user profile name.int
hashCode()
Returns a hash code for this principal.void
initialize(java.lang.String name)
Initializes a principal for the local IBM i system based on the given user profile name.void
setUserProfileName(java.lang.String name)
Sets the user profile name.java.lang.String
toString()
Returns a string representation of the object-
Methods inherited from class com.ibm.as400.security.auth.AS400Principal
addPropertyChangeListener, addVetoableChangeListener, getName, getSystem, getUser, removePropertyChangeListener, removeVetoableChangeListener, setSystem
-
-
-
-
Constructor Detail
-
UserProfilePrincipal
public UserProfilePrincipal()
Constructs a UserProfilePrincipal object.
-
UserProfilePrincipal
public UserProfilePrincipal(java.lang.String name)
Constructs a UserProfilePrincipal object with the principal name set to the supplied argument.- Parameters:
name
- The user profile name.
-
UserProfilePrincipal
public UserProfilePrincipal(AS400 system, java.lang.String name)
Constructs a UserProfilePrincipal object.The system and name properties are set to the specified values.
- Parameters:
system
- The system associated with the principal.name
- The user profile name.
-
-
Method Detail
-
equals
public boolean equals(java.lang.Object o)
Compares the specified Object with the credential for equality.- Specified by:
equals
in interfacejava.security.Principal
- Overrides:
equals
in classjava.lang.Object
- Parameters:
o
- Object to be compared for equality.- Returns:
- true if equal; otherwise false.
-
getUserProfileName
public java.lang.String getUserProfileName()
Returns the user profile name.- Specified by:
getUserProfileName
in interfaceAS400BasicAuthenticationPrincipal
- Overrides:
getUserProfileName
in classAS400Principal
- Returns:
- A String containing the name; empty if not assigned.
-
hashCode
public int hashCode()
Returns a hash code for this principal.- Specified by:
hashCode
in interfacejava.security.Principal
- Overrides:
hashCode
in classjava.lang.Object
- Returns:
- a hash code for this principal.
-
initialize
public void initialize(java.lang.String name) throws java.lang.Exception
Initializes a principal for the local IBM i system based on the given user profile name.- Specified by:
initialize
in interfaceAS400BasicAuthenticationPrincipal
- Parameters:
name
- The profile name.- Throws:
java.lang.Exception
- If an exception occurs.
-
setUserProfileName
public void setUserProfileName(java.lang.String name) throws java.beans.PropertyVetoException
Sets the user profile name.- Parameters:
name
- The profile name.- Throws:
java.beans.PropertyVetoException
- If the change is vetoed.ExtendedIllegalArgumentException
- If the provided value exceeds the maximum allowed length or contains non-valid characters.
-
toString
public java.lang.String toString()
Returns a string representation of the object- Specified by:
toString
in interfacejava.security.Principal
- Overrides:
toString
in classjava.lang.Object
- Returns:
- a string representation of the object.
-
-