Package com.axis.jenkins.plugins.eiffel.eiffelbroadcaster.eiffel

Class EiffelEvent

java.lang.Object

com.axis.jenkins.plugins.eiffel.eiffelbroadcaster.eiffel.EiffelEvent

Direct Known Subclasses:

EiffelActivityCanceledEvent, EiffelActivityFinishedEvent, EiffelActivityStartedEvent, EiffelActivityTriggeredEvent, EiffelArtifactCreatedEvent, EiffelArtifactPublishedEvent, GenericEiffelEvent

public class EiffelEvent
extends Object

A base class for Eiffel events that defines the common event attributes (meta and links) and makes it easy for subclasses to add an event-specific data attribute. See the Eiffel event documentation for each concrete event type for more on the meaning of the attributes.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EiffelEvent.Link
static class	EiffelEvent.Meta

Constructor Summary

Constructors

Constructor	Description
EiffelEvent(String type, String version)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
List<EiffelEvent.Link>	getLinks()
EiffelEvent.Meta	getMeta()
int	hashCode()
static void	setSourceProvider(SourceProvider provider)	Provide a SourceProvider instance that will be request to provide a EiffelEvent.Meta.Source object for each event created after that point.
void	sign(PrivateKey key, String identity, HashAlgorithm hashAlg)	Signs the current event in place using the given signing key, identity, and hash algorithm.
String	toJSON()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

EiffelEvent

public EiffelEvent(String type,
                   String version)

Method Detail

sign

public void sign(@NonNull
                 PrivateKey key,
                 @NonNull
                 String identity,
                 @NonNull
                 HashAlgorithm hashAlg)
          throws InvalidKeyException,
                 JsonCanonicalizationException,
                 NoSuchAlgorithmException,
                 SignatureException,
                 UnsupportedAlgorithmException

Signs the current event in place using the given signing key, identity, and hash algorithm.

Parameters:

key - the private key to use when producing the signature

identity - the distinguished name (DN) that identifies the author of the event

hashAlg - the hash algorithm to use when hashing the serialized form of the event

Throws:

InvalidKeyException - if the given private key was invalid

JsonCanonicalizationException - if there was an error serializing the event to canonical JSON form

NoSuchAlgorithmException - if the selected algorithm isn't supported by the available cryptography providers

SignatureException - if there's a general problem in the signing process

UnsupportedAlgorithmException - if the credential's signature algorithm isn't supported by this implementation of the Eiffel protocol or the available cryptography provider

getLinks

public List<EiffelEvent.Link> getLinks()

getMeta

public EiffelEvent.Meta getMeta()

setSourceProvider

public static void setSourceProvider(SourceProvider provider)

Provide a SourceProvider instance that will be request to provide a EiffelEvent.Meta.Source object for each event created after that point.

toJSON

public String toJSON()
              throws com.fasterxml.jackson.core.JsonProcessingException

Throws:

com.fasterxml.jackson.core.JsonProcessingException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object