Package org.springframework.vault.core.lease

Class SecretLeaseEventPublisher

java.lang.Object

org.springframework.vault.core.lease.SecretLeaseEventPublisher

All Implemented Interfaces:

InitializingBean

Direct Known Subclasses:

SecretLeaseContainer

public class SecretLeaseEventPublisher
extends Object
implements InitializingBean

Publisher for SecretLeaseEvents.

This publisher dispatches events to LeaseListener and LeaseErrorListener. Instances are thread-safe once initialized.

Author:

Mark Paluch

See Also:

• SecretLeaseEvent
• LeaseListener
• LeaseErrorListener

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	SecretLeaseEventPublisher.LoggingErrorListener	Simple LeaseErrorListener implementation to log errors.

Constructor Summary

Constructors

Constructor	Description
SecretLeaseEventPublisher()

Method Summary

Modifier and Type	Method	Description
void	addErrorListener(LeaseErrorListener listener)	Add a LeaseErrorListener to the container.
void	addLeaseListener(LeaseListener listener)	Add a LeaseListener to the container.
void	afterPropertiesSet()
protected void	onAfterLeaseRenewed(RequestedSecret requestedSecret, Lease lease)	Hook method called when a Lease is renewed.
protected void	onAfterLeaseRevocation(RequestedSecret requestedSecret, Lease lease)	Hook method called after triggering revocation for a Lease.
protected void	onBeforeLeaseRevocation(RequestedSecret requestedSecret, Lease lease)	Hook method called before triggering revocation for a Lease.
protected void	onError(RequestedSecret requestedSecret, Lease lease, Exception e)	Hook method called when an error occurred during secret retrieval, lease renewal, and other Vault interactions.
protected void	onLeaseExpired(RequestedSecret requestedSecret, Lease lease)	Hook method called when a Lease expires.
protected void	onSecretsNotFound(RequestedSecret requestedSecret)	Hook method called when secrets were not found.
protected void	onSecretsObtained(RequestedSecret requestedSecret, Lease lease, Map<String,Object> body)	Hook method called when secrets were obtained.
protected void	onSecretsRotated(RequestedSecret requestedSecret, Lease previousLease, Lease lease, Map<String,Object> body)	Hook method called when secrets were rotated.
void	removeLeaseErrorListener(LeaseErrorListener listener)	Remove a LeaseErrorListener.
void	removeLeaseListener(LeaseListener listener)	Remove a LeaseListener.

Methods inherited from class java.lang.Object

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

Constructor Details

SecretLeaseEventPublisher

public SecretLeaseEventPublisher()

Method Details

addLeaseListener

public void addLeaseListener(LeaseListener listener)

Add a LeaseListener to the container. The listener starts receiving events as soon as possible.

Parameters:

listener - lease listener, must not be null.

removeLeaseListener

public void removeLeaseListener(LeaseListener listener)

Remove a LeaseListener.

Parameters:

listener - must not be null.

addErrorListener

public void addErrorListener(LeaseErrorListener listener)

Add a LeaseErrorListener to the container. The listener starts receiving events as soon as possible.

Parameters:

listener - lease listener, must not be null.

removeLeaseErrorListener

public void removeLeaseErrorListener(LeaseErrorListener listener)

Remove a LeaseErrorListener.

Parameters:

listener - must not be null.

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

afterPropertiesSet in interface InitializingBean

onSecretsObtained

protected void onSecretsObtained(RequestedSecret requestedSecret,
 Lease lease,
 Map<String,Object> body)

Hook method called when secrets were obtained. The default implementation is to notify LeaseListener. Implementations can override this method in subclasses.

Parameters:

requestedSecret - must not be null.

lease - must not be null.

body - must not be null.

See Also:

• SecretLeaseCreatedEvent

onSecretsRotated

protected void onSecretsRotated(RequestedSecret requestedSecret,
 Lease previousLease,
 Lease lease,
 Map<String,Object> body)

Hook method called when secrets were rotated. The default implementation is to notify LeaseListener. Implementations can override this method in subclasses.

Parameters:

requestedSecret - must not be null.

lease - must not be null.

body - must not be null.

Since:

2.3

See Also:

• SecretLeaseRotatedEvent

onSecretsNotFound

protected void onSecretsNotFound(RequestedSecret requestedSecret)

Hook method called when secrets were not found. The default implementation is to notify LeaseListener. Implementations can override this method in subclasses.

Parameters:

requestedSecret - must not be null.

See Also:

• SecretNotFoundEvent

onAfterLeaseRenewed

protected void onAfterLeaseRenewed(RequestedSecret requestedSecret,
 Lease lease)

Hook method called when a Lease is renewed. The default implementation is to notify LeaseListener. Implementations can override this method in subclasses.

Parameters:

requestedSecret - must not be null.

lease - must not be null.

See Also:

• AfterSecretLeaseRenewedEvent

onBeforeLeaseRevocation

protected void onBeforeLeaseRevocation(RequestedSecret requestedSecret,
 Lease lease)

Hook method called before triggering revocation for a Lease. The default implementation is to notify LeaseListener. Implementations can override this method in subclasses.

Parameters:

requestedSecret - must not be null.

lease - must not be null.

See Also:

• BeforeSecretLeaseRevocationEvent

onAfterLeaseRevocation

protected void onAfterLeaseRevocation(RequestedSecret requestedSecret,
 Lease lease)

Hook method called after triggering revocation for a Lease. The default implementation is to notify LeaseListener. Implementations can override this method in subclasses.

Parameters:

requestedSecret - must not be null.

lease - must not be null.

See Also:

• AfterSecretLeaseRevocationEvent

onLeaseExpired

protected void onLeaseExpired(RequestedSecret requestedSecret,
 Lease lease)

Hook method called when a Lease expires. The default implementation is to notify LeaseListener. Implementations can override this method in subclasses.

Parameters:

requestedSecret - must not be null.

lease - must not be null.

See Also:

• SecretLeaseExpiredEvent

onError

protected void onError(RequestedSecret requestedSecret,
 @Nullable
 Lease lease,
 Exception e)

Hook method called when an error occurred during secret retrieval, lease renewal, and other Vault interactions. The default implementation is to notify LeaseErrorListener. Implementations can override this method in subclasses.

Parameters:

requestedSecret - must not be null.

lease - may be null

e - the causing exception.

See Also:

• SecretLeaseErrorEvent