com.hcl.domino.keep.saml

Enum KeepSAMLimpl

java.lang.Object

java.lang.Enum<KeepSAMLimpl>

com.hcl.domino.keep.saml.KeepSAMLimpl

All Implemented Interfaces:

KeepSAML, java.io.Serializable, java.lang.Comparable<KeepSAMLimpl>

public enum KeepSAMLimpl
extends java.lang.Enum<KeepSAMLimpl>
implements KeepSAML

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE Singleton through enum

Method Summary

Modifier and Type	Method and Description
void	freeUserIdHandle(java.lang.String userName) Deallocate memory for user id file
java.lang.String	getErrorString(short status) Get the notes error message from a status code
com.sun.jna.Pointer	getKFHandle(java.lang.String idfile) Given a user id file name, convert to KFHANDLE
java.lang.String	getPrivKey() return Keep instance private key
java.lang.String	getPubKey() return Keep instance public key
static java.lang.String	getServerHTTPName(java.lang.String dnName) Given a Notes DN-formatted server name, find the http name
java.lang.String	getX509Cert()
java.util.Optional<SamlUserId>	lookupUserId(java.lang.String dominoName) Checks for a SamlUserId
void	releaseAllIDs() Delete all cached id files
short	retrieveUserID(java.lang.String userEmail, java.lang.String dominoName, java.lang.String currentClaim) Retrieve the user id using a SAML dance.
void	setPrivKey(java.lang.String privKey) store Keep private key
void	setPubKey(java.lang.String pubKey) store Keep public key
void	setX509Cert(java.lang.String x509Cert) store Keep public certificate
static KeepSAMLimpl	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static KeepSAMLimpl[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INSTANCE

public static final KeepSAMLimpl INSTANCE

Singleton through enum

Method Detail

values

public static KeepSAMLimpl[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (KeepSAMLimpl c : KeepSAMLimpl.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static KeepSAMLimpl valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getServerHTTPName

public static java.lang.String getServerHTTPName(java.lang.String dnName)

Given a Notes DN-formatted server name, find the http name

Parameters:

dnName - Domino name format

Returns:

http host name if found

freeUserIdHandle

public void freeUserIdHandle(java.lang.String userName)

Deallocate memory for user id file

Specified by:

freeUserIdHandle in interface KeepSAML

Parameters:

userName - Domino name in abbreviated form

getErrorString

public java.lang.String getErrorString(short status)

Get the notes error message from a status code

Specified by:

getErrorString in interface KeepSAML

Parameters:

status - error code

Returns:

error message, if found

getKFHandle

public com.sun.jna.Pointer getKFHandle(java.lang.String idfile)

Given a user id file name, convert to KFHANDLE

Specified by:

getKFHandle in interface KeepSAML

Parameters:

idfile - file name

Returns:

KFHANDLE Pointer

getPrivKey

public java.lang.String getPrivKey()

return Keep instance private key

Specified by:

getPrivKey in interface KeepSAML

Returns:

the key

getPubKey

public java.lang.String getPubKey()

return Keep instance public key

Specified by:

getPubKey in interface KeepSAML

Returns:

the key

getX509Cert

public java.lang.String getX509Cert()

Specified by:

getX509Cert in interface KeepSAML

Returns:

public certificate

lookupUserId

public java.util.Optional<SamlUserId> lookupUserId(java.lang.String dominoName)

Description copied from interface: KeepSAML

Checks for a SamlUserId

Specified by:

lookupUserId in interface KeepSAML

Returns:

Optional, empty if not found

releaseAllIDs

public void releaseAllIDs()

Delete all cached id files

Specified by:

releaseAllIDs in interface KeepSAML

retrieveUserID

public short retrieveUserID(java.lang.String userEmail,
                            java.lang.String dominoName,
                            java.lang.String currentClaim)

Retrieve the user id using a SAML dance. Info about the user is cached locally

Specified by:

retrieveUserID in interface KeepSAML

Parameters:

userEmail - User’s public email (e.g. jerrygarcia@prod.hclpnp.com)

dominoName - User’s mapped Domino name (abbreviated or full DN) (e.g. Jerry Garcia/ProjectKeep)

currentClaim - JWT claim with expire info

Returns:

status code. Zero is “no error”

setPrivKey

public void setPrivKey(java.lang.String privKey)

store Keep private key

Specified by:

setPrivKey in interface KeepSAML

Parameters:

privKey - private key

setPubKey

public void setPubKey(java.lang.String pubKey)

store Keep public key

Specified by:

setPubKey in interface KeepSAML

Parameters:

pubKey - public key

setX509Cert

public void setX509Cert(java.lang.String x509Cert)

store Keep public certificate

Specified by:

setX509Cert in interface KeepSAML

Parameters:

x509Cert - public certificate