OpenJDK 27 · com.sun.security.auth.UnixPrincipal · APIdia, the JavaDoc alternative

This class implements the Principal interface and represents a Unix user.

Principals such as this UnixPrincipal may be associated with a particular Subject to augment that Subject with an additional identity. Refer to the Subject class for more information on how to achieve this. Authorization decisions can then be based upon the Principals associated with a Subject.

Field Summary

Modifier and Type	Field and Description
private String	name
private static final long	serialVersionUID

Constructor Summary

Access	Constructor and Description
public	UnixPrincipal(String the Unix username for this user. name) Create a UnixPrincipal with a Unix username.

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: true if the specified Object is equal to this `UnixPrincipal`. equals(Object Object to be compared for equality with this `UnixPrincipal`. o) Overrides java.lang.Object.equals. Implements java.security.Principal.equals. Compares the specified Object with this `UnixPrincipal` for equality.
public String	Returns: the Unix username for this `UnixPrincipal` getName() Implements java.security.Principal.getName. Return the Unix username for this `UnixPrincipal`.
public int	Returns: a hash code for this `UnixPrincipal`. hashCode() Overrides java.lang.Object.hashCode. Implements java.security.Principal.hashCode. Return a hash code for this `UnixPrincipal`.
private void	readObject(ObjectInputStream the `ObjectInputStream` from which data is read stream) Restores the state of this object from the stream.
public String	Returns: a string representation of this `UnixPrincipal`. toString() Overrides java.lang.Object.toString. Implements java.security.Principal.toString. Return a string representation of this `UnixPrincipal`.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

Field Detail

name	back to summary
private String name

serialVersionUID	back to summary
private static final long serialVersionUID Annotations @Serial

Constructor Detail

UnixPrincipal back to summary

UnixPrincipal	back to summary
public UnixPrincipal(String name) Create a UnixPrincipal with a Unix username. Parameters name:String the Unix username for this user. Exceptions NullPointerException: if the `name` is `null`.

public UnixPrincipal(String name)

Create a UnixPrincipal with a Unix username.

Parameters

name:String: the Unix username for this user.

Exceptions

NullPointerException:: if the name is null.

Method Detail

equals back to summary

equals	back to summary
public boolean equals(Object o) Overrides java.lang.Object.equals. Implements java.security.Principal.equals. Compares the specified Object with this `UnixPrincipal` for equality. Returns true if the given object is also a `UnixPrincipal` and the two UnixPrincipals have the same username. Parameters o:Object Object to be compared for equality with this `UnixPrincipal`. Returns:boolean true if the specified Object is equal to this `UnixPrincipal`.

public boolean equals(Object o)

Overrides java.lang.Object.equals.

Implements java.security.Principal.equals.

Compares the specified Object with this UnixPrincipal for equality. Returns true if the given object is also a UnixPrincipal and the two UnixPrincipals have the same username.

Parameters

o:Object: Object to be compared for equality with this UnixPrincipal.

Returns:boolean

true if the specified Object is equal to this UnixPrincipal.

getName back to summary

getName	back to summary
public String getName() Implements java.security.Principal.getName. Return the Unix username for this `UnixPrincipal`. Returns:String the Unix username for this `UnixPrincipal`

public String getName()

Implements java.security.Principal.getName.

Return the Unix username for this UnixPrincipal.

Returns:String: the Unix username for this UnixPrincipal

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Implements java.security.Principal.hashCode. Return a hash code for this `UnixPrincipal`. Returns:int a hash code for this `UnixPrincipal`.

public int hashCode()

Overrides java.lang.Object.hashCode.

Implements java.security.Principal.hashCode.

Return a hash code for this UnixPrincipal.

Returns:int: a hash code for this UnixPrincipal.

readObject back to summary

readObject	back to summary
private void readObject(ObjectInputStream stream) throws IOException, ClassNotFoundException Restores the state of this object from the stream. Parameters stream:ObjectInputStream the `ObjectInputStream` from which data is read Annotations @Serial Exceptions IOException: if an I/O error occurs ClassNotFoundException: if a serialized class cannot be loaded

private void readObject(ObjectInputStream stream) throws IOException, ClassNotFoundException

Restores the state of this object from the stream.

Parameters

stream:ObjectInputStream: the ObjectInputStream from which data is read

Annotations

@Serial

Exceptions

IOException:: if an I/O error occurs
ClassNotFoundException:: if a serialized class cannot be loaded

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Implements java.security.Principal.toString. Return a string representation of this `UnixPrincipal`. Returns:String a string representation of this `UnixPrincipal`.

public String toString()

Overrides java.lang.Object.toString.

Implements java.security.Principal.toString.

Return a string representation of this UnixPrincipal.

Returns:String: a string representation of this UnixPrincipal.

public Class UnixPrincipal

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail