Top Description Fields Constructors Methods
org.apache.http.auth

public final Class BasicUserPrincipal

extends Object
implements Principal, Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable, java.security.Principal
Annotations
@Contract
threading:IMMUTABLE
Imports
java.io.Serializable, java.security.Principal, org.apache.http.annotation.Contract, .ThreadingBehavior, org.apache.http.util.Args, .LangUtils
Basic user principal used for HTTP authentication
Since
4.0

Field Summary

Modifier and TypeField and Description
private static final long
serialVersionUID

private final String
username

Constructor Summary

AccessConstructor and Description
public
BasicUserPrincipal(final String username)

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(final Object
Principal to compare with.
o)

Overrides java.lang.Object.equals.

Implements java.security.Principal.equals.

Compares this Principal to the specified object.
public String
getName()

Implements java.security.Principal.getName.

Returns the name of this Principal.
public int
hashCode()

Overrides java.lang.Object.hashCode.

Implements java.security.Principal.hashCode.

Returns a hashcode for this Principal.
public String
toString()

Overrides java.lang.Object.toString.

Implements java.security.Principal.toString.

Returns a string representation of this Principal.
Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

serialVersionUIDback to summary
private static final long serialVersionUID
usernameback to summary
private final String username

Constructor Detail

BasicUserPrincipalback to summary
public BasicUserPrincipal(final String username)

Method Detail

equalsback to summary
public boolean equals(final Object o)

Overrides java.lang.Object.equals.

Implements java.security.Principal.equals.

Doc from java.security.Principal.equals.

Compares this Principal to the specified object. Returns true if the object passed in matches the Principal represented by the implementation of this interface.

Parameters
o:Object

Principal to compare with.

Returns:boolean

true if the Principal passed in is the same as that encapsulated by this Principal, and false otherwise.

Annotations
@Override
getNameback to summary
public String getName()

Implements java.security.Principal.getName.

Doc from java.security.Principal.getName.

Returns the name of this Principal.

Returns:String

the name of this Principal.

Annotations
@Override
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Implements java.security.Principal.hashCode.

Doc from java.security.Principal.hashCode.

Returns a hashcode for this Principal.

Returns:int

a hashcode for this Principal.

Annotations
@Override
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Implements java.security.Principal.toString.

Doc from java.security.Principal.toString.

Returns a string representation of this Principal.

Returns:String

a string representation of this Principal.

Annotations
@Override