oracle.ifs.common

Class SystemUserCredential

java.lang.Object

oracle.ifs.common.SystemUserCredential

All Implemented Interfaces:

Serializable, Credential

public class SystemUserCredential
extends Object
implements Credential

A SystemUserCredential encapsulates information required to create a 'system' user session.

Version:

1.0

See Also:

Serialized Form

(Published)

Field Summary

Fields

Modifier and Type	Field and Description
protected DataSource	m_DataSource The datasource.
protected String	m_Password The password.
protected Object	m_ServiceToken The service token.

Constructor Summary

Constructors

Constructor and Description
SystemUserCredential() Constructs a SystemUserCredential.
SystemUserCredential(DataSource dataSource) Constructs a SystemUserCredential.
SystemUserCredential(Object serviceToken) Constructs a SystemUserCredential.
SystemUserCredential(String password) Constructs a SystemUserCredential.

Method Summary

Modifier and Type	Method and Description
DataSource	getDataSource() Gets the DataSource.
String	getName() Gets the name of the user.
String	getPassword() Gets the password.
Object	getServiceToken() Gets the service token.
boolean	isDataSourceBased() Returns true if the Credentiual is based on a DataSource.
boolean	isSchemaPasswordBased() Returns true if the Credentiual is based on schema password.
boolean	isServiceTokenBased() Returns true if the Credentiual is based on a service token.
void	setName(String name) Sets the name of the user.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

m_Password

protected String m_Password

The password.

(Unpublished)

m_DataSource

protected DataSource m_DataSource

The datasource.

(Unpublished)

m_ServiceToken

protected Object m_ServiceToken

The service token.

(Unpublished)

Constructor Detail

SystemUserCredential

public SystemUserCredential()

Constructs a SystemUserCredential.

(Published)

SystemUserCredential

public SystemUserCredential(String password)
                     throws IfsException

Constructs a SystemUserCredential.

Parameters:

password - the password

Throws:

IfsException - if the operation fails

(Published)

SystemUserCredential

public SystemUserCredential(DataSource dataSource)
                     throws IfsException

Constructs a SystemUserCredential.

Parameters:

dataSource - the DataSource

Throws:

IfsException - if the operation fails

(Published)

SystemUserCredential

public SystemUserCredential(Object serviceToken)
                     throws IfsException

Constructs a SystemUserCredential.

Parameters:

serviceToken - the serviceToken

Throws:

IfsException - if the operation fails

(Published)

Method Detail

getPassword

public String getPassword()

Gets the password.

Returns:

the password

(Published)

getDataSource

public DataSource getDataSource()

Gets the DataSource.

Returns:

the DataSource

(Published)

getServiceToken

public Object getServiceToken()

Gets the service token.

Returns:

the service token

(Published)

isSchemaPasswordBased

public boolean isSchemaPasswordBased()

Returns true if the Credentiual is based on schema password.

Returns:

true if the Credentiual is based on schema password

(Published)

isDataSourceBased

public boolean isDataSourceBased()
                          throws IfsException

Returns true if the Credentiual is based on a DataSource.

Returns:

true if the Credentiual is based on a DataSource

Throws:

IfsException

(Published)

isServiceTokenBased

public boolean isServiceTokenBased()
                            throws IfsException

Returns true if the Credentiual is based on a service token.

Returns:

true if the Credentiual is based on a service token

Throws:

IfsException

(Published)

getName

public String getName()
               throws IfsException

Description copied from interface: Credential

Gets the name of the user.

Specified by:

getName in interface Credential

Returns:

the name of the user

Throws:

IfsException - (IFS-10187) if the operation fails

setName

public void setName(String name)
             throws IfsException

Description copied from interface: Credential

Sets the name of the user.

Specified by:

setName in interface Credential

Parameters:

name - the name of the user

Throws:

IfsException - (IFS-10188) if the operation fails