javax.wbem.client
Class UserPrincipal

java.lang.Object
  |
  +--javax.wbem.client.UserPrincipal

All Implemented Interfaces:

java.security.Principal, java.io.Serializable

public class UserPrincipal

extends java.lang.Object

implements java.security.Principal, java.io.Serializable

This class implements a Java security Principal identity for a client user identity that authenticates with a Unix username and login password. That is, it represents the user's login identity on the remote server system which is running the CIMOM.

Since:

WBEM 2.0

See Also:

Serialized Form

Constructor Summary

UserPrincipal()
Empty constructor.

UserPrincipal(java.lang.String userName)
This constructor accepts the user name.

Method Summary

boolean	equals(java.lang.Object otherPrincipal) The equals method checks if the specified object is the same principal as this object.
java.lang.String	getHostName() Return the server host name where this principal identity was authenticated.
java.lang.String	getName() Return the name of this principal identity; that is, return the Unix user login name.
java.lang.String	getUserName() Return the principal's login user name.
int	hashCode() The hashCode method returns an integer hash code to represent this principal.
void	setHostName(java.lang.String hostName) Set the server host name where this principal was authenticated.
void	setUserName(java.lang.String userName) Set the principal user login name.
java.lang.String	toString() The toString method returns a string representation of the principal suitable for displaying in messages.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UserPrincipal

public UserPrincipal()

Empty constructor.

UserPrincipal

public UserPrincipal(java.lang.String userName)

This constructor accepts the user name.

Parameters:

userName - The user login name.

Method Detail

getName

public java.lang.String getName()

Return the name of this principal identity; that is, return the Unix user login name.

Specified by:

getName in interface java.security.Principal

Returns:

The name of this principal identity.

equals

public boolean equals(java.lang.Object otherPrincipal)

The equals method checks if the specified object is the same principal as this object. The principals are equal if the specified object is an instance of UserPrincipal and the user name and authentication host name are the same.

Specified by:

equals in interface java.security.Principal

Overrides:

equals in class java.lang.Object

Parameters:

otherPrincipal - Principal instance to compare for equality

Returns:

The name of this principal identity.

toString

public java.lang.String toString()

The toString method returns a string representation of the principal suitable for displaying in messages. It should not be used for making authorization checks, however. The format of the returned string is "user @ host".

Specified by:

toString in interface java.security.Principal

Overrides:

toString in class java.lang.Object

Returns:

A printable string form of the principal identity.

hashCode

public int hashCode()

The hashCode method returns an integer hash code to represent this principal. It can be used to test for non-equality, or as an index key in a hash table.

Specified by:

hashCode in interface java.security.Principal

Overrides:

hashCode in class java.lang.Object

Returns:

An integer hash code representing the principal.

getUserName

public java.lang.String getUserName()

Return the principal's login user name.

Returns:

The user login name.

getHostName

public java.lang.String getHostName()

Return the server host name where this principal identity was authenticated. If null, not yet authenticated.

Returns:

The server host name.

setUserName

public void setUserName(java.lang.String userName)

Set the principal user login name.

Parameters:

userName - The user login name.

setHostName

public void setHostName(java.lang.String hostName)

Set the server host name where this principal was authenticated.

Parameters:

hostName - The server host name.