Package dev.galasa.zossecurity

Interface IZosKeyring

public interface IZosKeyring

Represents a keyring that has been created.

Method Summary

Modifier and Type	Method	Description
void	connectCertificate(IZosCertificate certificate)	Connect this keyring to a certificate
void	connectCertificate(IZosCertificate certificate, boolean defaultCertificate)	Connect this keyring to a certificate
void	connectCertificate(IZosCertificate certificate, boolean defaultCertificate, RACFCertificateType usage)	Connect this keyring to a certificate
void	connectCertificate(String userid, String label)	Connect this keyring to a certificate which outside the control of Galasa
void	connectCertificate(String userid, String label, boolean defaultCertificate)	Connect this keyring to a certificate which outside the control of Galasa
void	delete()	Delete this keyring
void	free()	Free the keyring.
String	getLabel()	Retieve the label of this keyring
String	getUserid()	Retrieve the userid this keyring has been attached to
String	list()	List the keyring
void	removeCertificate(IZosCertificate certificate)	Remove a certificate from this keyring
void	removeCertificate(String userid, String label)	Remove a non Galasa certificate from this keyring

Method Details

getUserid

String getUserid()

Retrieve the userid this keyring has been attached to

Returns:

The userid

getLabel

String getLabel()

Retieve the label of this keyring

Returns:

The Label

delete

void delete()
     throws ZosSecurityManagerException

Delete this keyring

Throws:

ZosSecurityManagerException

connectCertificate

void connectCertificate(IZosCertificate certificate,
 boolean defaultCertificate,
 RACFCertificateType usage)
                 throws ZosSecurityManagerException

Connect this keyring to a certificate

Parameters:

certificate - - The certificate to connect to

defaultCertificate - - Mark this certificate as the default in the keyring

usage - - The USAGE to use when connecting

Throws:

ZosSecurityManagerException

connectCertificate

void connectCertificate(IZosCertificate certificate,
 boolean defaultCertificate)
                 throws ZosSecurityManagerException

Connect this keyring to a certificate

Parameters:

certificate - - The certificate to connect to

defaultCertificate - - Mark this certificate as the default in the keyring

Throws:

ZosSecurityManagerException

connectCertificate

void connectCertificate(String userid,
 String label,
 boolean defaultCertificate)
                 throws ZosSecurityManagerException

Connect this keyring to a certificate which outside the control of Galasa

Parameters:

userid - - The userid that owns the certificate

label - - The label of the certificate

defaultCertificate - - Mark this certificate as the default in the keyring

Throws:

ZosSecurityManagerException

connectCertificate

void connectCertificate(IZosCertificate certificate)
                 throws ZosSecurityManagerException

Connect this keyring to a certificate

Parameters:

certificate - - The certificate to connect to

Throws:

ZosSecurityManagerException

connectCertificate

void connectCertificate(String userid,
 String label)
                 throws ZosSecurityManagerException

Connect this keyring to a certificate which outside the control of Galasa

Parameters:

userid - - The userid that owns the certificate

label - - The label of the certificate

Throws:

ZosSecurityManagerException

removeCertificate

void removeCertificate(IZosCertificate certificate)
                throws ZosSecurityManagerException

Remove a certificate from this keyring

Parameters:

certificate - - The certificate to remove

Throws:

ZosSecurityManagerException

removeCertificate

void removeCertificate(String userid,
 String label)
                throws ZosSecurityManagerException

Remove a non Galasa certificate from this keyring

Parameters:

userid - - The userid that owns the certificate

label - - The label of the certificate

Throws:

ZosSecurityManagerException

list

String list()
     throws ZosSecurityManagerException

List the keyring

Returns:

Throws:

ZosSecurityManagerException

free

void free()
   throws ZosSecurityManagerException

Free the keyring. This will be performed automatically at the end of the run

Throws:

ZosSecurityManagerException