A C D E F G H I J K L M N P R S T U W

A

AdvancedResponseFormatter - Interface in com.caplin.keymaster.servlet

This interface allows a user to specify a UserCredentialsProvider class that can be used to supply user credentials.

C

closeLog() - Method in class com.caplin.keymaster.FileLogger

Send the log to file associated with it.

com.caplin.keymaster - package com.caplin.keymaster

Provides all the classes to verify a token.

com.caplin.keymaster.error - package com.caplin.keymaster.error

Provides all the error classes for key generation.

com.caplin.keymaster.keygenerator - package com.caplin.keymaster.keygenerator

Creates a set of public/private keys.

com.caplin.keymaster.keyimporter - package com.caplin.keymaster.keyimporter

Utilities that imports a private key into a hardware KeyStore and verify the successful import operation.

com.caplin.keymaster.servlet - package com.caplin.keymaster.servlet

Provides all the classes used when creating a token for a request.

CONFIG_LOGGER_FILE - Static variable in class com.caplin.keymaster.servlet.StandardKeyMaster

The underlying file that the logging messages will be written out to.

CONFIG_LOGGER_FILE - Static variable in class examples.flatfile.FlatFileServlet

The file that all the logging information will be written to.

CONFIG_LOGGER_LEVEL - Static variable in class com.caplin.keymaster.servlet.StandardKeyMaster

The logging level that is required.

CONFIG_LOGGER_LEVEL - Static variable in class examples.flatfile.FlatFileServlet

The level of logging required while this servlet is running.

D

DEFAULT_FORMATTER_TYPE - Static variable in class com.caplin.keymaster.servlet.StandardKeyMaster

Specify the default type of ResponseFormatter used by the servlet

DEFAULT_LOG_FILE - Static variable in class com.caplin.keymaster.servlet.StandardKeyMaster

Specify the default log file used by the servlet to keep track of all log messages.

DEFAULT_LOG_FILE - Static variable in class examples.flatfile.FlatFileServlet

Specifies a default file to use.

DEFAULT_LOG_LEVEL - Static variable in class com.caplin.keymaster.servlet.StandardKeyMaster

Specify the default level of logging provided by the servlet in the event that a Level is not specified or an invalid one is specified.

DEFAULT_LOG_LEVEL - Static variable in class examples.flatfile.FlatFileServlet

Specifies a defualt Level in case the one specified is missing or is invalid.

DEFAULT_WIRE_TYPE - Static variable in class examples.news.NewsFormatter

Specifies the default value of 'wires' if the one supplied was invalid.

Dependencies - Class in com.caplin.keymaster.servlet

Dependencies() - Constructor for class com.caplin.keymaster.servlet.Dependencies

destroy() - Method in class com.caplin.keymaster.servlet.StandardKeyMaster

Used to close the logger instance as the servlet is no longer going to be used.

E

examples.flatfile - package examples.flatfile

Provides an example of a HTTPS servlet as an alternative to BasicAuthenticator.

examples.jndi - package examples.jndi

examples.news - package examples.news

Provides a sample implementation of the ResponseFormatter interface.

EXTRA_DATA_PROVIDER - Static variable in class com.caplin.keymaster.servlet.StandardKeyMaster

Specify this attribute in the servlet configuration file to load a custom class which will add extra data to the signed token passed to Liberator.

ExtraDataProvider - Interface in com.caplin.keymaster.servlet

This Interface allows customised extra data to be added to KeyMaster's signed token.

F

FileLogger - Class in com.caplin.keymaster

This class sets up a Logger instance to allow the other classes in the com.caplin.keymaster and examples packages.

FileLogger(Properties) - Constructor for class com.caplin.keymaster.FileLogger

Constructor to set the name, level and file handler for the logger.

FileLogger(String, String) - Constructor for class com.caplin.keymaster.FileLogger

This constructor was added to the class to allow StandardKeyMaster class to create an instance.

FlatFileServlet - Class in examples.flatfile

This is a simple example of a HTTPS servlet that uses KeyMaster.

FlatFileServlet() - Constructor for class examples.flatfile.FlatFileServlet

flush() - Method in class com.caplin.keymaster.FileLogger

Flush any messages held in the logger to the associated filestream.

formatErrorResponse(HttpServletRequest, String) - Method in class com.caplin.keymaster.servlet.HTMLFormatter

This method formats an error response into a proper format for JavaScript applications that use an HTML response.

formatErrorResponse(HttpServletRequest, String) - Method in class com.caplin.keymaster.servlet.JavaScriptFormatter

This method formats an error response into a proper format for JavaScript.

formatErrorResponse(HttpServletRequest, String) - Method in interface com.caplin.keymaster.servlet.ResponseFormatter

This method can be called from the servlet if there was an error while trying to process the request or generate a token.

formatErrorResponse(HttpServletRequest, String) - Method in class com.caplin.keymaster.servlet.StreamLinkFormatter

This method calls com.caplin.credentials.util.RemoteCredentialsEncoder#encodeErrorResponse to format an appropriate error response.

formatErrorResponse(HttpServletRequest, String) - Method in class examples.news.NewsFormatter

This method records in the log than an error response is being returned and what the error was.

formatResponse(HttpServletRequest, String, UserCredentialsProvider) - Method in interface com.caplin.keymaster.servlet.AdvancedResponseFormatter

This is the main method for the interface.

formatResponse(HttpServletRequest, String) - Method in class com.caplin.keymaster.servlet.HTMLFormatter

This method will encode a response suitable for JavaScript type applications (e.g.

formatResponse(HttpServletRequest, String, UserCredentialsProvider) - Method in class com.caplin.keymaster.servlet.HTMLFormatter

This method will encode a response suitable for JavaScript type applications (e.g.

formatResponse(HttpServletRequest, String) - Method in class com.caplin.keymaster.servlet.JavaScriptFormatter

This method will encode a response suitable for JavaScript type applications (e.g.

formatResponse(HttpServletRequest, String, UserCredentialsProvider) - Method in class com.caplin.keymaster.servlet.JavaScriptFormatter

This method will encode a response suitable for JavaScript type applications (e.g.

formatResponse(HttpServletRequest, String) - Method in interface com.caplin.keymaster.servlet.ResponseFormatter

Deprecated. Use AdvancedResponseFormatter.formatResponse(HttpServletRequest, String, UserCredentialsProvider) instead.

formatResponse(HttpServletRequest, String) - Method in class com.caplin.keymaster.servlet.StreamLinkFormatter

This method formats the response for the successful creation of a token.

formatResponse(HttpServletRequest, String, UserCredentialsProvider) - Method in class com.caplin.keymaster.servlet.StreamLinkFormatter

This method formats the response for the successful creation of a token.

formatResponse(HttpServletRequest, String) - Method in class examples.news.NewsFormatter

Implementation of the interface method.

FORMATTER_TYPE_PREFIX - Static variable in class com.caplin.keymaster.servlet.StandardKeyMaster

The pattern used at initialisation to identify all the valid types of ResponseFormatter that the servlet can deal with.

G

generate() - Method in class com.caplin.keymaster.keygenerator.KeyGenerator

Generates a pair of keys using the KeyPairGenerator method generateKeyPair.

generateToken(String) - Method in class com.caplin.keymaster.KeyMaster

Generates a unique credentials token that the client can use to log in to Liberator.

generateToken(String, String) - Method in class com.caplin.keymaster.KeyMaster

Generates a unique credentials token that the client can use to log in to Liberator.

generateToken(String, Map<String, String>) - Method in class com.caplin.keymaster.KeyMaster

Generates a unique credentials token that the client can use to log in to Liberator.

generateToken(String, String, Map<String, String>) - Method in class com.caplin.keymaster.KeyMaster

Generates a unique credentials token that the client can use to log in to Liberator.

getExtraDataToSign(HttpServletRequest, String) - Method in interface com.caplin.keymaster.servlet.ExtraDataProvider

Provides extra data to be added to the signed token which will be passed to Liberator.

getKeyMaster(Properties) - Static method in class com.caplin.keymaster.KeyMaster

Gets a KeyMaster that has been configured with the specified properties.

getMappingData(HttpServletRequest) - Method in interface com.caplin.keymaster.servlet.MappingDataProvider

StandardKeyMaster calls this method to get a map of key-value pairs, and adds this data to the signed credentials token it generates.

getToken() - Method in class com.caplin.keymaster.KeyMaster

Deprecated.

The use case of generating a token without a username will not be supported in future versions.

Gets a unique token that a client can use to log into the Liberator.

getToken(String) - Method in class com.caplin.keymaster.KeyMaster

Deprecated.

Use KeyMaster.generateToken(String, String) instead.

Gets a unique token that a client can use to log into the Liberator.

The extraDataToSign argument can be used to sign extra information that can be passed to Liberator. This extra data will be signed as part of the generated token.

getUseRemoteUser() - Method in class com.caplin.keymaster.servlet.UserCredentialsProvider

Gets whether the RemoteUser header should be used to obtain the username or not.

getUserName(HttpServletRequest) - Method in class com.caplin.keymaster.servlet.UserCredentialsProvider

Invoked when the StandardKeyMaster needs to get the username to send back in the response to the client.

getWrappedException() - Method in exception com.caplin.keymaster.error.WrappedException

Gets the Exception that this class was instantiated with.

H

HTMLFormatter - Class in com.caplin.keymaster.servlet

This ResponseFormatter is specially designed to link in with SL4B.

HTMLFormatter() - Constructor for class com.caplin.keymaster.servlet.HTMLFormatter

I

init() - Method in class com.caplin.keymaster.servlet.StandardKeyMaster

Initialisation method to set up the servlet and prepare for HTTP Get and Post calls.

init(ServletConfig) - Method in class com.caplin.keymaster.servlet.StandardKeyMaster

Initialisation method to set up the servlet and prepare for HTTP Get and Post calls.

init() - Method in class examples.flatfile.FlatFileServlet

This method is called by the application server when the server loads or when this servlet is called for the first time.

init() - Method in class examples.jndi.JndiKeyMasterServlet

InitialisationFailedException - Exception in com.caplin.keymaster.error

This class is used throughout KeyMaster in the event that there is an exception thrown while a class is being instantiated.

InitialisationFailedException() - Constructor for exception com.caplin.keymaster.error.InitialisationFailedException

This constructor calls its parent empty constructor to take care of the processing.

InitialisationFailedException(String) - Constructor for exception com.caplin.keymaster.error.InitialisationFailedException

This constructor calls its parent constructor with the cause of the exception.

J

JavaScriptFormatter - Class in com.caplin.keymaster.servlet

This ResponseFormatter is specially designed to link in with RTSL, RTML and WebSheet.

JavaScriptFormatter() - Constructor for class com.caplin.keymaster.servlet.JavaScriptFormatter

JndiKeyMasterServlet - Class in examples.jndi

Generates a KeyMaster using some configuration from JNDI parameters caplin.keymaster.encrypting.generator.private.key.store.filename - The location of the keystore.relative to the webapp.

JndiKeyMasterServlet() - Constructor for class examples.jndi.JndiKeyMasterServlet

K

KeyGenerator - Class in com.caplin.keymaster.keygenerator

KeyGenerator creates a set of keys, one private, one public and another version of the public key in DER (binary) format.

KeyGenerator(String, String) - Constructor for class com.caplin.keymaster.keygenerator.KeyGenerator

This constructor initialises the class variables to the properties specified in the properties file.

KeyImporter - Class in com.caplin.keymaster.keyimporter

Class used to import keys into a hardware key storage solution.

KeyImportVerifier - Class in com.caplin.keymaster.keyimporter

Class used to verify that keys imported using the KeyImporter class are present in the hardware storage module.

KeyMaster - Class in com.caplin.keymaster

Provides methods to generate the credentials token that can be passed back to the client, and that the client can use to log in to Liberator.

KeyMasterXHRFrame - Class in com.caplin.keymaster.servlet

KeyMasterXHRFrame() - Constructor for class com.caplin.keymaster.servlet.KeyMasterXHRFrame

L

LOGGERNAME - Static variable in class com.caplin.keymaster.KeyMaster

The name of the Logger used by KeyMaster.

M

main(String[]) - Static method in class com.caplin.keymaster.keygenerator.KeyGenerator

Creates an instance of the KeyGenerator class and generates the three keys.

main(String[]) - Static method in class com.caplin.keymaster.keyimporter.KeyImporter

Program entry point.

main(String[]) - Static method in class com.caplin.keymaster.keyimporter.KeyImportVerifier

Program entry point.

MappingDataProvider - Interface in com.caplin.keymaster.servlet

This interface allows you to define mapping data that StandardKeyMaster adds to the signed credentials tokens it generates.

N

NewsFormatter - Class in examples.news

This is a simple example of how you can implement your own ResponseFormatter to suit your own needs.

NewsFormatter() - Constructor for class examples.news.NewsFormatter

P

Poll - Class in com.caplin.keymaster.servlet

Poll() - Constructor for class com.caplin.keymaster.servlet.Poll

POSSIBLE_WIRE_TYPES - Static variable in class examples.news.NewsFormatter

Specifies the different types of 'wires' that are valid.

POSSIBLE_WIRE_VALUES - Static variable in class examples.news.NewsFormatter

Specifies the relevant response to each valid value for 'wires'.

printStackTraceDeep() - Method in exception com.caplin.keymaster.error.WrappedException

Calls WrappedException.printStackTraceDeep(PrintWriter) with the standard system error output stream.

printStackTraceDeep(PrintWriter) - Method in exception com.caplin.keymaster.error.WrappedException

Calls the super method Throwable.printStackTrace(java.io.PrintWriter) to do a stack trace and then calls the same method belonging to the Exception this class was instantiated with.

printStackTraceDeep(PrintStream) - Method in exception com.caplin.keymaster.error.WrappedException

Casts the PrintStream into a PrintWriter and then calls printStackTraceDeep( PrintWriter pw ) belonging to this class.

PROPS_ENABLE_VALUE - Static variable in class com.caplin.keymaster.servlet.StandardKeyMaster

Allow the HTTP remote user credentials to be used.

PROPS_ENCODE_EXTRA_DATA - Static variable in class com.caplin.keymaster.servlet.StandardKeyMaster

Allows the user to add optional data to the token being created.

PROPS_HARDWARE_KEYSTORE_KEY_PASSPHRASE - Static variable in class com.caplin.keymaster.servlet.StandardKeyMaster

Optional property that specifies the passphrase to use when retrieving the key from a hardware storage solution.

PROPS_HARDWARE_KEYSTORE_KEYFILE - Static variable in class com.caplin.keymaster.servlet.StandardKeyMaster

Optional property that specifies the location of a key file used to load the KeyStore when using a hardware storage solution.

PROPS_HARDWARE_KEYSTORE_PASSPHRASE - Static variable in class com.caplin.keymaster.servlet.StandardKeyMaster

Optional property that specifies the passphrase to use when loading the KeyStore when using a hardware storage solution.

PROPS_HARDWARE_KEYSTORE_PROVIDER - Static variable in class com.caplin.keymaster.servlet.StandardKeyMaster

Optional property that specifies the name of the KeyStore provider to retrieve keys from when using a hardware key storage solution.

PROPS_HARDWARE_KEYSTORE_TYPE - Static variable in class com.caplin.keymaster.servlet.StandardKeyMaster

Optional property that specifies the type of KeyStore to retrieve keys from when using a hardware key storage solution.

PROPS_HTTP_USER - Static variable in class com.caplin.keymaster.servlet.StandardKeyMaster

Determines if the username should be the username provided by one of the Caplin products or whether it should use the standard HTTP remote user that will be generated when the user logs in via a single sign on system.

PROPS_KEY_PRFILE - Static variable in class com.caplin.keymaster.servlet.StandardKeyMaster

The file name and location of the private key created by KeyGenerator.

PROPS_KEYMASTER_URL - Static variable in class com.caplin.keymaster.servlet.KeyMasterXHRFrame

PROPS_KEYSTORE_TYPE - Static variable in class com.caplin.keymaster.servlet.StandardKeyMaster

A switch that can be set to "standard" or "hardware" to indicate if KeyMaster should use a standard KeyStore file or a hardware key storage solution.

PROPS_POLL_URL - Static variable in class com.caplin.keymaster.servlet.KeyMasterXHRFrame

PROPS_SECURITY_CLASS - Static variable in class com.caplin.keymaster.servlet.StandardKeyMaster

The class name of the security provider used by this class.

PROPS_SECURITY_NAME - Static variable in class com.caplin.keymaster.servlet.StandardKeyMaster

A name to identify the security provider by.

PROPS_SERVER_NAME - Static variable in class com.caplin.keymaster.servlet.StandardKeyMaster

The identifier passed to KeyGenerator used when creating the set of keys.

PROPS_SIGNATURE_ALGORITHM - Static variable in class com.caplin.keymaster.servlet.StandardKeyMaster

Optional property that specifies which algorithm to use when generating tokens.

PROPS_VALUE_TO_ENABLE_ENCODE_EXTRA_DATA - Static variable in class com.caplin.keymaster.servlet.StandardKeyMaster

Allow the addition of extra information onto the token being sent to Liberator.

R

ResponseFormatter - Interface in com.caplin.keymaster.servlet

This interface is designed to be used by developers who wish to customise the type of response being returned by a request for a token.

S

setUseRemoteUser(boolean) - Method in class com.caplin.keymaster.servlet.UserCredentialsProvider

Sets whether the RemoteUser header should be used to obtain the username or not.

StandardKeyMaster - Class in com.caplin.keymaster.servlet

This class is used as a basic servlet to show how KeyMaster is used to authenticate a user and return an appropriate response.

StandardKeyMaster() - Constructor for class com.caplin.keymaster.servlet.StandardKeyMaster

StreamLinkFormatter - Class in com.caplin.keymaster.servlet

This class formats the response passed into it so that the response will be compatible with StreamLink (for Java/C++/Excel etc).

StreamLinkFormatter() - Constructor for class com.caplin.keymaster.servlet.StreamLinkFormatter

T

toStringDeep() - Method in exception com.caplin.keymaster.error.WrappedException

Get a detailed description of what has gone wrong and why this class has been instantiated.

U

USER_PROVIDER_CLASS_CONFIG - Static variable in class com.caplin.keymaster.servlet.StandardKeyMaster

Specify this attribute in the servlet configuration file to load a custom user credentials class.

UserCredentialsProvider - Class in com.caplin.keymaster.servlet

Class used to provide user credentials to the defined response formatters.

UserCredentialsProvider() - Constructor for class com.caplin.keymaster.servlet.UserCredentialsProvider

W

WRAPPED_MESSAGE - Static variable in exception com.caplin.keymaster.error.WrappedException

This will contain the reason why the exception that was thrown.

WrappedException - Exception in com.caplin.keymaster.error

This class provides a way of wrapping up all the different exceptions associated with KeyMaster.

WrappedException(String, Exception) - Constructor for exception com.caplin.keymaster.error.WrappedException

Call the Exception constructor using the message parameter and set class varibales.

WrappedException(Exception) - Constructor for exception com.caplin.keymaster.error.WrappedException

Call the empty Exception constructor and initalise class varibales.

A C D E F G H I J K L M N P R S T U W