*** This API provides Binary Compatibility only, not Source Compatibility ***

com.sas.services.information.metadata
Interface LoginInterface

All Superinterfaces:

MetadataInterface,

All Known Implementing Classes:

LdapLogin, OMRLogin,

public interface LoginInterface

extends MetadataInterface

This is a generic interface for interacting with a repository entry that represents a login object.

Since:

1.0

Fields inherited from interface com.sas.services.information.metadata.MetadataInterface

PERMISSION_READMETADATA, PERMISSION_WRITEMETADATA

Method Summary

void	addUser(PersonInterface user) Add a user to the list of allowed clients.
String	getDomain() Get the security domain for the login.
int	getMinAvail() Returns the minimum number of servers that should be started when this login is used to authenticate.
int	getMinSize() Returns the minimum size pooling parameter.
String	getPassword() Get the password for the login.
String	getUserId() Get the user ID for this login.
List	getUsers() Get a list of the users that are authorized to use this login.
void	removeUser(PersonInterface user) Remove a user from the list of allowed clients.
void	setMinAvail(int min) Set the minimum available pooling parameter.
void	setMinSize(int size) Set the minimum size pooling parameter.
void	setPassword(String password) Set the password for this login.
void	setUserId(String uid) Set the user ID for this login.

Methods inherited from interface com.sas.services.information.metadata.MetadataInterface

add, addAccessControl, addAttribute, addAttributes, addExtension, addKeyword, addPermissions, addRemark, addTransactionListener, checkin, checkout, commit, copyTo, delete, deleteAttribute, deleteAttributes, getAccessControls, getAttribute, getAttributes, getCreateDate, getDescription, getEntityKey, getEntityURL, getExtensions, getGUID, getIdentities, getKeywords, getModifyDate, getName, getParentPath, getParents, getPath, getPaths, getPathUrl, getPathUrl, getPermission, getPermissions, getPermissions, getPreviousVersionNames, getRemarksList, getReposId, getRepository, getRepositoryEntity, getReposKey, getTrackingId, getType, getVersion, isAuthorized, isLoggingEnabled, logMessage, mapNameToFilesystem, mapUrlToFilesystem, moveTo, newServiceObject, refresh, removeAccessControl, removeExtension, removeKeyword, removePermissions, rollback, setAttribute, setAttributes, setDescription, setGUID, setKeywords, setName, setPermission, setRemarksList, setRepository, startTransaction, transactionEvent, uncheckout, update, version

Method Detail

getUserId

public String getUserId()
                 throws RemoteException

Get the user ID for this login.

Returns:

The user id.

Throws:

RemoteException - in the event of remote object failure.

setUserId

public void setUserId(String uid)
               throws RemoteException

Set the user ID for this login.

Parameters:

uid - The new user id.

Throws:

RemoteException - in the event of remote object failure.

getPassword

public String getPassword()
                   throws RemoteException

Get the password for the login.

Returns:

the password.

Throws:

RemoteException - in the event of remote object failure.

setPassword

public void setPassword(String password)
                 throws RemoteException

Set the password for this login.

Parameters:

password - The new password.

Throws:

RemoteException - in the event of remote object failure.

getDomain

public String getDomain()
                 throws RemoteException

Get the security domain for the login.

Returns:

The security domain.

Throws:

RemoteException - in the event of remote object failure.

getUsers

public List getUsers()
              throws RemoteException

Get a list of the users that are authorized to use this login.

Returns:

A list of Person objects that are allowed to use this login.

Throws:

RemoteException - in the event of remote object failure.

addUser

public void addUser(PersonInterface user)
             throws RemoteException

Add a user to the list of allowed clients.

Parameters:

user - The new user to add to the allowed clients.

Throws:

RemoteException - in the event of remote object failure.

removeUser

public void removeUser(PersonInterface user)
                throws RemoteException

Remove a user from the list of allowed clients.

Parameters:

user - The user to remove from the allowed client list.

Throws:

RemoteException - in the event of remote object failure.

getMinAvail

public int getMinAvail()
                throws RemoteException

Returns the minimum number of servers that should be started when this login is used to authenticate.

Returns:

The minimum available server count.

Throws:

RemoteException - in the event of remote object failure.

setMinAvail

public void setMinAvail(int min)
                 throws RemoteException

Set the minimum available pooling parameter.

Parameters:

min - The new minimum available setting.

Throws:

RemoteException - in the event of remote object failure.

getMinSize

public int getMinSize()
               throws RemoteException

Returns the minimum size pooling parameter.

Returns:

The minsize.

Throws:

RemoteException - in the event of remote object failure.

setMinSize

public void setMinSize(int size)
                throws RemoteException

Set the minimum size pooling parameter.

Parameters:

size - The new minimum size parameter.

Throws:

RemoteException - in the event of remote object failure.

*** This API provides Binary Compatibility only, not Source Compatibility ***