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

Class Util

java.lang.Object

com.axis.jenkins.plugins.eiffel.eiffelbroadcaster.Util

public final class Util
extends Object

Constants and helper functions.

Author:

Isac Holm <isac.holm@axis.com>

Method Summary

Modifier and Type	Method	Description
static String	getFullName(Queue.Task t)	Fetches the full name task name if available.
static List<String>	getLinesInString(String s)	Splits the input string into lines, removes leading and trailing whitespace, and returns non-empty lines in a list.
static URI	getRunUri(Run r, String... pathSuffix)	Returns the URI of a Run, or one of its subresources.
static com.fasterxml.jackson.databind.JsonNode	mustPublishEvent(EiffelEvent event, EventSigner signer)	Publishes an EiffelEvent and raises an exception if an error occurs.
static com.fasterxml.jackson.databind.JsonNode	publishEvent(EiffelEvent event, EventSigner signer)	Publishes an EiffelEvent and logs a message if there's an error.
static EiffelActivityFinishedEvent.Data.Outcome.Conclusion	translateStatus(String status)	Translate Jenkins job status into corresponding eiffel status.

Methods inherited from class java.lang.Object

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

Method Detail

getFullName

public static String getFullName(Queue.Task t)

Fetches the full name task name if available.

Parameters:

t - Queue.task

Returns:

full name if available, else the short name

getRunUri

public static URI getRunUri(Run r,
                            String... pathSuffix)

Returns the URI of a Run, or one of its subresources.

Parameters:

r - the Run to return the URI for

pathSuffix - additional path components to append

Returns:

the URI asked for, or null if a URI couldn't be resolved

mustPublishEvent

@CheckForNull
public static com.fasterxml.jackson.databind.JsonNode mustPublishEvent(@NonNull
                                                                       EiffelEvent event,
                                                                       @CheckForNull
                                                                       EventSigner signer)
                                                                throws EventValidationFailedException,
                                                                       InvalidCertificateConfigurationException,
                                                                       InvalidKeyException,
                                                                       JsonCanonicalizationException,
                                                                       com.fasterxml.jackson.core.JsonProcessingException,
                                                                       KeyStoreException,
                                                                       NoSuchAlgorithmException,
                                                                       SchemaUnavailableException,
                                                                       SignatureException,
                                                                       UnsupportedAlgorithmException,
                                                                       UnrecoverableKeyException

Publishes an EiffelEvent and raises an exception if an error occurs.

Parameters:

event - the Eiffel event to publish

signer - the EventSigner that should be called to get the event signed (if signing has been enabled), or null if signing should be disabled

Returns:

the published event or null if event publishing is disabled

Throws:

EventValidationFailedException - if the validation of the event against the JSON schema fails

InvalidCertificateConfigurationException - if the keystore in the certificate credential was entirely empty or its first item didn't contain a certificate with a private key

InvalidKeyException - if the given private key was invalid

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

com.fasterxml.jackson.core.JsonProcessingException - if there's an error during JSON serialization

KeyStoreException - if the KeyStore hasn't been initialized (shouldn't happen and indicates a bug)

NoSuchAlgorithmException - if the algorithm needed to decrypt the key isn't available

SchemaUnavailableException - if there's no schema available for the supplied event

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

UnrecoverableKeyException

publishEvent

@CheckForNull
public static com.fasterxml.jackson.databind.JsonNode publishEvent(@NonNull
                                                                   EiffelEvent event,
                                                                   @CheckForNull
                                                                   EventSigner signer)

Publishes an EiffelEvent and logs a message if there's an error.

Parameters:

event - the Eiffel event to publish

signer - the EventSigner that should be called to get the event signed (if signing has been enabled), or null if signing should be disabled

Returns:

the published event or null if there was an error or event publishing is disabled

getLinesInString

public static List<String> getLinesInString(String s)

Splits the input string into lines, removes leading and trailing whitespace, and returns non-empty lines in a list.

Parameters:

s - the line to split

translateStatus

public static EiffelActivityFinishedEvent.Data.Outcome.Conclusion translateStatus(String status)

Translate Jenkins job status into corresponding eiffel status.

Parameters:

status - jenkins job status to translate.

Returns:

translated status.