SDK/J Authentication Package ver1.0
RICOH Confidential
A C G H I J N P R S U V

A

AlreadySetException - exception jp.co.ricoh.dsdk.opt.auth.ccm.AlreadySetException.
This is an exception class that is thrown when a CcmRequestHandler has been already set to a CcmService.
AlreadySetException() - Constructor for class jp.co.ricoh.dsdk.opt.auth.ccm.AlreadySetException
Constructs an exception class with no message.
AlreadySetException(String) - Constructor for class jp.co.ricoh.dsdk.opt.auth.ccm.AlreadySetException
Constructs an exception class with a message.

C

Ccm - class jp.co.ricoh.dsdk.opt.auth.ccm.Ccm.
This is the front end class of Panel Service.
Ccm() - Constructor for class jp.co.ricoh.dsdk.opt.auth.ccm.Ccm
Constructs a Ccm object.
CcmRequest - interface jp.co.ricoh.dsdk.opt.auth.ccm.CcmRequest.
This is an interface for a request from the authentication module of the device.
CcmRequestHandler - interface jp.co.ricoh.dsdk.opt.auth.ccm.CcmRequestHandler.
This is an interface which handles requests from the CcmService (ie CcmRequest).
CcmService - interface jp.co.ricoh.dsdk.opt.auth.ccm.CcmService.
This is an interface to use the user authentication service of the device.
CcmServiceException - exception jp.co.ricoh.dsdk.opt.auth.ccm.CcmServiceException.
This is an exception class that is thrown when an error has ocurred in the CcmService.
CcmServiceException() - Constructor for class jp.co.ricoh.dsdk.opt.auth.ccm.CcmServiceException
Constructs an exception class with no message.
CcmServiceException(String) - Constructor for class jp.co.ricoh.dsdk.opt.auth.ccm.CcmServiceException
Constructs an exception class with a message.
cancelLogin() - Method in interface jp.co.ricoh.dsdk.opt.auth.ccm.CcmService
Deprecated.  This method is NOT supported. This method is not implemented currently. Use requestLogout() method instead.

G

getName() - Method in class jp.co.ricoh.dsdk.opt.auth.ccm.Name
Returns the login user name.
getPIN() - Method in class jp.co.ricoh.dsdk.opt.auth.ccm.VerifyPIN
Gets the PIN.
getPassword() - Method in class jp.co.ricoh.dsdk.opt.auth.ccm.Password
Returns the login password.
getService() - Method in class jp.co.ricoh.dsdk.opt.auth.ccm.Ccm
Returns the CcmService object.

H

handle(CcmRequest[]) - Method in interface jp.co.ricoh.dsdk.opt.auth.ccm.CcmRequestHandler
This method will be called by a CcmService.

I

InvalidPINException - exception jp.co.ricoh.dsdk.opt.auth.ccm.InvalidPINException.
This is an exception class that is thrown when a PIN verification has failed.
InvalidPINException() - Constructor for class jp.co.ricoh.dsdk.opt.auth.ccm.InvalidPINException
Constructs an exception class with no message.
InvalidPINException(String) - Constructor for class jp.co.ricoh.dsdk.opt.auth.ccm.InvalidPINException
Constructs an exception class with a message.

J

jp.co.ricoh.dsdk.opt.auth.ccm - package jp.co.ricoh.dsdk.opt.auth.ccm
This package provides APIs to access the user authentication service of the device.

N

Name - class jp.co.ricoh.dsdk.opt.auth.ccm.Name.
This is a CcmRequest for a login user name.
Name() - Constructor for class jp.co.ricoh.dsdk.opt.auth.ccm.Name
 

P

Password - class jp.co.ricoh.dsdk.opt.auth.ccm.Password.
This is a CcmRequest for a login password.
Password() - Constructor for class jp.co.ricoh.dsdk.opt.auth.ccm.Password
 
ProviderNotFoundException - exception jp.co.ricoh.dsdk.opt.auth.ccm.ProviderNotFoundException.
This is an exception class that is thrown when a provider class is not found.
ProviderNotFoundException() - Constructor for class jp.co.ricoh.dsdk.opt.auth.ccm.ProviderNotFoundException
Constructs an exception class with no message.
ProviderNotFoundException(String) - Constructor for class jp.co.ricoh.dsdk.opt.auth.ccm.ProviderNotFoundException
Constructs an exception class with a message.

R

removeRequestHandler(CcmRequestHandler) - Method in interface jp.co.ricoh.dsdk.opt.auth.ccm.CcmService
Removes the CcmRequestHandler.
requestLogin() - Method in interface jp.co.ricoh.dsdk.opt.auth.ccm.CcmService
Sends a login request to the user authentication service.
requestLogout() - Method in interface jp.co.ricoh.dsdk.opt.auth.ccm.CcmService
Sends a logout request to the user authentication service if the user is already logged in.

S

setName(byte[]) - Method in class jp.co.ricoh.dsdk.opt.auth.ccm.Name
Sets the login user name.
setPassword(byte[]) - Method in class jp.co.ricoh.dsdk.opt.auth.ccm.Password
Sets the login password.
setRequestHandler(CcmRequestHandler) - Method in interface jp.co.ricoh.dsdk.opt.auth.ccm.CcmService
Sets the CcmRequestHandler.

U

UnsupportedRequestException - exception jp.co.ricoh.dsdk.opt.auth.ccm.UnsupportedRequestException.
This is an exception class that is thrown when a CcmRequest is unsupported by a CcmRequestHandler.
UnsupportedRequestException() - Constructor for class jp.co.ricoh.dsdk.opt.auth.ccm.UnsupportedRequestException
Constructs an exception class with no message.
UnsupportedRequestException(String) - Constructor for class jp.co.ricoh.dsdk.opt.auth.ccm.UnsupportedRequestException
Constructs an exception class with a message.

V

VerifyPIN - class jp.co.ricoh.dsdk.opt.auth.ccm.VerifyPIN.
This is a CcmRequest for a PIN verification.
VerifyPIN(byte[]) - Constructor for class jp.co.ricoh.dsdk.opt.auth.ccm.VerifyPIN
Constructs a VerifyPIN object with the given PIN.

A C G H I J N P R S U V
SDK/J Authentication Package ver1.0
RICOH Confidential