Package com.cloudbees.plugins.credentials

Interface CredentialsUseListener

All Superinterfaces:

ExtensionPoint

public interface CredentialsUseListener
extends ExtensionPoint

A Listener to track Credentials usage.

See Also:

• CredentialsProvider.trackAll(Item, List)
• CredentialsProvider.trackAll(Run, List)
• CredentialsProvider.trackAll(Node, List)

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Method Summary

Modifier and Type	Method	Description
static void	fireUse(Credentials c, Item item)	Fires the onUse(com.cloudbees.plugins.credentials.Credentials, hudson.model.Run) event to track the item that uses credentials.
static void	fireUse(Credentials c, Node node)	Fires the onUse(com.cloudbees.plugins.credentials.Credentials, hudson.model.Run) event to track the node that uses credentials.
static void	fireUse(Credentials c, Run run)	Fires the onUse(com.cloudbees.plugins.credentials.Credentials, hudson.model.Run) event to track the run that uses credentials.
void	onUse(Credentials c, Item item)	Called when Credentials is read by an item.
void	onUse(Credentials c, Node node)	Called when Credentials is read by a node.
void	onUse(Credentials c, Run run)	Called when Credentials is read by a run.

Method Details

onUse

void onUse(Credentials c,
 Run run)

Called when Credentials is read by a run.

Parameters:

c - The used Credentials.

run - The run using the credentials.

onUse

void onUse(Credentials c,
 Node node)

Called when Credentials is read by a node.

Parameters:

c - The used Credentials.

node - The node using the credentials.

onUse

void onUse(Credentials c,
 Item item)

Called when Credentials is read by an item.

Parameters:

c - The used Credentials.

item - The item using the credentials.

fireUse

static void fireUse(Credentials c,
 Run run)

Fires the onUse(com.cloudbees.plugins.credentials.Credentials, hudson.model.Run) event to track the run that uses credentials.

See Also:

• CredentialsProvider.trackAll(Run, List)

fireUse

static void fireUse(Credentials c,
 Node node)

Fires the onUse(com.cloudbees.plugins.credentials.Credentials, hudson.model.Run) event to track the node that uses credentials.

See Also:

• CredentialsProvider.trackAll(Node, List)

fireUse

static void fireUse(Credentials c,
 Item item)

Fires the onUse(com.cloudbees.plugins.credentials.Credentials, hudson.model.Run) event to track the item that uses credentials.

See Also:

• CredentialsProvider.trackAll(Item, List)