jp.co.ricoh.dsdk.opt.auth.ccm
Interface CcmService

public interface CcmService

This is an interface to use the user authentication service of the device.

Method Summary

void	cancelLogin() Deprecated. This method is NOT supported. This method is not implemented currently. Use requestLogout() method instead.
void	removeRequestHandler(CcmRequestHandler handler) Removes the CcmRequestHandler.
void	requestLogin() Sends a login request to the user authentication service.
void	requestLogout() Sends a logout request to the user authentication service if the user is already logged in.
void	setRequestHandler(CcmRequestHandler handler) Sets the CcmRequestHandler.

Method Detail

requestLogin

public void requestLogin()

Sends a login request to the user authentication service.

cancelLogin

public void cancelLogin()

Deprecated. This method is NOT supported. This method is not implemented currently. Use requestLogout() method instead.

Cancels the login request. Note that this method is used to cancel the prior login request, NOT used to request logout.

requestLogout

public void requestLogout()

Sends a logout request to the user authentication service if the user is already logged in. Cancels the login request if the user is on a login sequence

setRequestHandler

public void setRequestHandler(CcmRequestHandler handler)
                       throws AlreadySetException

Sets the CcmRequestHandler.

Parameters:

handler - the implemention of CcmRequestHandler.

Throws:

AlreadySetException - an implemention of CcmRequestHandler has been already set to this service.

removeRequestHandler

public void removeRequestHandler(CcmRequestHandler handler)

Removes the CcmRequestHandler.

Parameters:

handler - the implementation of the CcmRequestHandler.