com.hcl.domino.keep.saml

Interface KeepSAML

All Known Implementing Classes:

KeepSAMLimpl

public interface KeepSAML

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
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 emailName, java.lang.String dominoName, java.lang.String jwtClaim) 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

Method Detail

freeUserIdHandle

void freeUserIdHandle(java.lang.String userName)

Deallocate memory for user id file

Parameters:

userName - Domino name in abbreviated form

getErrorString

java.lang.String getErrorString(short status)

Get the notes error message from a status code

Parameters:

status - error code

Returns:

error message, if found

getKFHandle

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

Given a user id file name, convert to KFHANDLE

Parameters:

idfile - file name

Returns:

KFHANDLE Pointer

getPrivKey

java.lang.String getPrivKey()

return Keep instance private key

Returns:

the key

getPubKey

java.lang.String getPubKey()

return Keep instance public key

Returns:

the key

getX509Cert

java.lang.String getX509Cert()

Returns:

public certificate

lookupUserId

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

Checks for a SamlUserId

Parameters:

dominoName -

Returns:

Optional, empty if not found

releaseAllIDs

void releaseAllIDs()

Delete all cached id files

retrieveUserID

short retrieveUserID(java.lang.String emailName,
                     java.lang.String dominoName,
                     java.lang.String jwtClaim)

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

Parameters:

emailName - 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)

jwtClaim - current JWT Claim, used to compute cache expiration

Returns:

status code. Zero is “no error”

setPrivKey

void setPrivKey(java.lang.String privKey)

store Keep private key

Parameters:

privKey - private key

setPubKey

void setPubKey(java.lang.String pubKey)

store Keep public key

Parameters:

pubKey - public key

setX509Cert

void setX509Cert(java.lang.String x509Cert)

store Keep public certificate

Parameters:

x509Cert - public certificate