Package io.jenkins.plugins.ksm.notation

Class KsmNotation

java.lang.Object

io.jenkins.plugins.ksm.notation.KsmNotation

Direct Known Subclasses:

KsmTestNotation

public class KsmNotation
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static String	notationPrefix

Constructor Summary

Constructors

Constructor	Description
KsmNotation()

Method Summary

Modifier and Type	Method	Description
byte[]	downloadDataFile(com.keepersecurity.secretsManager.core.KeeperFile file)
static KsmNotationItem	find(String envVar, String notation, boolean allowFailure)	Check in envVar is a keeper notation and then attempt to parse it.
com.keepersecurity.secretsManager.core.KeeperSecrets	getNotationSecrets(com.keepersecurity.secretsManager.core.SecretsManagerOptions options, List<String> uids)
static KsmNotationItem	parse(KsmSecret item, boolean allowFailure)	Parse a KsmSecret instance.
static KsmNotationItem	parse(String envVar, String notation, boolean allowFailure)	Parse an environmental variable notation.
static KsmNotationItem	parse(String destination, String envVar, String filePath, String notation, boolean allowFailure)	Parse notation and keeper track the destination
void	run(KsmCredential credential, Map<String,KsmNotationItem> items)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

notationPrefix

public static final String notationPrefix

See Also:

Constant Field Values

Constructor Detail

KsmNotation

public KsmNotation()

Method Detail

find

public static KsmNotationItem find(String envVar,
                                   String notation,
                                   boolean allowFailure)
                            throws Exception

Check in envVar is a keeper notation and then attempt to parse it.

Parameters:

envVar - The name of the environmental variable

notation - The keeper notation

allowFailure - Allow failure, don't throw exception, but log the error.

Returns:

KsmNotationItem

Throws:

Exception - The parse failed for this reason.

parse

public static KsmNotationItem parse(KsmSecret item,
                                    boolean allowFailure)
                             throws Exception

Parse a KsmSecret instance.

Parameters:

item - An instance of KsmSecret

allowFailure - Allow failure, don't throw exception, but log the error.

Returns:

KsmNotationItem

Throws:

Exception - The parse failed for this reason.

parse

public static KsmNotationItem parse(String envVar,
                                    String notation,
                                    boolean allowFailure)
                             throws Exception

Parse an environmental variable notation.

Parameters:

envVar - The name of the environmental variable

notation - The keeper notation

allowFailure - Allow failure, don't throw exception, but log the error.

Returns:

KsmNotationItem

Throws:

Exception - The parse failed for this reason.

parse

public static KsmNotationItem parse(String destination,
                                    String envVar,
                                    String filePath,
                                    String notation,
                                    boolean allowFailure)
                             throws Exception

Parse notation and keeper track the destination

Parameters:

destination - Flag indicating in the destination is an environmental var or file path.

envVar - The name of the environmental variable

filePath - Path to where the secret should be stored on disk.

notation - The keeper notation

allowFailure - Allow failure, don't throw exception, but log the error.

Returns:

KsmNotationItem

Throws:

Exception - The parse failed for this reason.

getNotationSecrets

public com.keepersecurity.secretsManager.core.KeeperSecrets getNotationSecrets(com.keepersecurity.secretsManager.core.SecretsManagerOptions options,
                                                                               List<String> uids)

downloadDataFile

public byte[] downloadDataFile(com.keepersecurity.secretsManager.core.KeeperFile file)

run

public void run(KsmCredential credential,
                Map<String,KsmNotationItem> items)
         throws Exception

Throws:

Exception