OpenJDK 27 · com.sun.net.httpserver.HttpPrincipal · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private String	realm
private String	username

Access	Constructor and Description
public	HttpPrincipal(String the name of the user within the realm username, String the realm for this user realm) Creates a `HttpPrincipal` from the given `username` and `realm`.

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: `true` or `false` depending on whether objects are equal or not equals(Object the object to compare this instance of `HttpPrincipal` against another) Overrides java.lang.Object.equals. Implements java.security.Principal.equals. Compare two instances of `HttpPrincipal`.
public String	Returns: the contents of this principal in the form realm:username getName() Implements java.security.Principal.getName. Returns the contents of this principal in the form realm:username.
public String	Returns: the realm associated with this object getRealm() Returns the `realm` this object was created with.
public String	Returns: the name of the user associated with this object getUsername() Returns the `username` this object was created with.
public int	Returns: the hashcode for this object hashCode() Overrides java.lang.Object.hashCode. Implements java.security.Principal.hashCode. Returns a hashcode for this `HttpPrincipal`.
public String	Returns: the name associated with this object toString() Overrides java.lang.Object.toString. Implements java.security.Principal.toString. Returns the same string as `getName()`.

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

Field Detail

realm	back to summary
private String realm

username	back to summary
private String username

Constructor Detail

HttpPrincipal back to summary

HttpPrincipal	back to summary
public HttpPrincipal(String username, String realm) Creates a `HttpPrincipal` from the given `username` and `realm`. Parameters username:String the name of the user within the realm realm:String the realm for this user Exceptions NullPointerException: if either username or realm are `null`

public HttpPrincipal(String username, String realm)

Creates a HttpPrincipal from the given username and realm.

Parameters

username:String: the name of the user within the realm
realm:String: the realm for this user

Exceptions

NullPointerException:: if either username or realm are null

Method Detail

equals back to summary

equals	back to summary
public boolean equals(Object another) Overrides java.lang.Object.equals. Implements java.security.Principal.equals. Compare two instances of `HttpPrincipal`. Returns `true` if another is an instance of `HttpPrincipal`, and its username and realm are equal to this object's username and realm. Returns `false` otherwise. Parameters another:Object the object to compare this instance of `HttpPrincipal` against Returns:boolean `true` or `false` depending on whether objects are equal or not

public boolean equals(Object another)

Overrides java.lang.Object.equals.

Implements java.security.Principal.equals.

Compare two instances of HttpPrincipal. Returns true if another is an instance of HttpPrincipal, and its username and realm are equal to this object's username and realm. Returns false otherwise.

Parameters

another:Object: the object to compare this instance of HttpPrincipal against

Returns:boolean

true or false depending on whether objects are equal or not

getName	back to summary
public String getName() Implements java.security.Principal.getName. Returns the contents of this principal in the form realm:username. Returns:String the contents of this principal in the form realm:username

getName

back to summary

public String getName()

Implements java.security.Principal.getName.

Returns the contents of this principal in the form realm:username.

Returns:String: the contents of this principal in the form realm:username

getRealm back to summary

getRealm	back to summary
public String getRealm() Returns the `realm` this object was created with. Returns:String the realm associated with this object

public String getRealm()

Returns the realm this object was created with.

Returns:String: the realm associated with this object

getUsername back to summary

getUsername	back to summary
public String getUsername() Returns the `username` this object was created with. Returns:String the name of the user associated with this object

public String getUsername()

Returns the username this object was created with.

Returns:String: the name of the user associated with this object

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Implements java.security.Principal.hashCode. Returns a hashcode for this `HttpPrincipal`. This is calculated as `(getUsername()+getRealm()).hashCode()`. Returns:int the hashcode for this object

public int hashCode()

Overrides java.lang.Object.hashCode.

Implements java.security.Principal.hashCode.

Returns a hashcode for this HttpPrincipal. This is calculated as (getUsername()+getRealm()).hashCode().

Returns:int: the hashcode for this object

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Implements java.security.Principal.toString. Returns the same string as `getName()`. Returns:String the name associated with this object

public String toString()

Overrides java.lang.Object.toString.

Implements java.security.Principal.toString.

Returns the same string as getName().

Returns:String: the name associated with this object

public Class HttpPrincipal

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail