com.atlassian.bamboo.logger
Class DefaultErrorHandler

java.lang.Object
  extended by com.atlassian.bamboo.logger.AbstractErrorUpdateHandler
      extended by com.atlassian.bamboo.logger.DefaultErrorHandler
All Implemented Interfaces:
ErrorAccessor, ErrorHandler, ErrorUpdateHandler

public class DefaultErrorHandler
extends AbstractErrorUpdateHandler
implements ErrorHandler

This class keeps track of Bamboo build errors so they can get reported to the user.


Field Summary
 
Fields inherited from class com.atlassian.bamboo.logger.AbstractErrorUpdateHandler
agentContext
 
Constructor Summary
DefaultErrorHandler(AgentContext agentContext, com.atlassian.event.api.EventPublisher eventPublisher)
           
 
Method Summary
 void clear()
          Remove all errors from the handler
 void createElasticError(String context, Long agentId, ThrowableDetails throwableDetails, String instanceId)
          Create an error regarding Elastic Bamboo.
 void createError(String planKey, Integer buildNumber, Long agentId, String context, ThrowableDetails throwableDetails)
           
 Collection<ErrorDetails> getAllErrors()
          Get all the errors recorded against all builds
 Collection<ErrorDetails> getElasticErrors()
          Get all the errors recorded against elastic bamboo
 ErrorDetails getErrorDetails(String buildKey, int errorNumber)
          Obtain the specified error from the handler.
 Collection<ErrorDetails> getErrors(Key planKey)
          Obtain all the errors recorded against a specific plan
 Collection<ErrorDetails> getErrors(ResultKey resultKey)
          Obtain all the errors recorded against a specific result
 Collection<ErrorDetails> getErrorsByAgentId(Long agentId)
          Obtain all the errors recorded filtered by Agent Id
 void removeBuildErrors(String buildKey)
          Remove all the errors for a given build
 void removeError(String buildKey, int errorNumber)
          Remove a specific error from the handler.
 
Methods inherited from class com.atlassian.bamboo.logger.AbstractErrorUpdateHandler
addErrorCollection, getCurrentAgentId, recordElasticError, recordError, recordError, recordError, recordError, recordError
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.atlassian.bamboo.logger.ErrorUpdateHandler
addErrorCollection, recordElasticError, recordError, recordError, recordError, recordError, recordError
 

Constructor Detail

DefaultErrorHandler

public DefaultErrorHandler(AgentContext agentContext,
                           com.atlassian.event.api.EventPublisher eventPublisher)
Method Detail

createElasticError

public void createElasticError(String context,
                               @Nullable
                               Long agentId,
                               @Nullable
                               ThrowableDetails throwableDetails,
                               @Nullable
                               String instanceId)
Description copied from interface: ErrorUpdateHandler
Create an error regarding Elastic Bamboo.

Specified by:
createElasticError in interface ErrorUpdateHandler

createError

public void createError(@Nullable
                        String planKey,
                        Integer buildNumber,
                        Long agentId,
                        String context,
                        ThrowableDetails throwableDetails)
Specified by:
createError in interface ErrorUpdateHandler

getErrors

@NotNull
public Collection<ErrorDetails> getErrors(@NotNull
                                                  ResultKey resultKey)
Description copied from interface: ErrorAccessor
Obtain all the errors recorded against a specific result

Specified by:
getErrors in interface ErrorAccessor
Returns:
The collection ErrorDetails

getErrors

@NotNull
public Collection<ErrorDetails> getErrors(@NotNull
                                                  Key planKey)
Description copied from interface: ErrorAccessor
Obtain all the errors recorded against a specific plan

Specified by:
getErrors in interface ErrorAccessor
Returns:
The collection ErrorDetails

getAllErrors

@NotNull
public Collection<ErrorDetails> getAllErrors()
Description copied from interface: ErrorAccessor
Get all the errors recorded against all builds

Specified by:
getAllErrors in interface ErrorAccessor
Returns:
The collection ErrorDetails

getErrorsByAgentId

@NotNull
public Collection<ErrorDetails> getErrorsByAgentId(Long agentId)
Description copied from interface: ErrorAccessor
Obtain all the errors recorded filtered by Agent Id

Specified by:
getErrorsByAgentId in interface ErrorAccessor
Returns:
The collection ErrorDetails

getElasticErrors

@NotNull
public Collection<ErrorDetails> getElasticErrors()
Description copied from interface: ErrorAccessor
Get all the errors recorded against elastic bamboo

Specified by:
getElasticErrors in interface ErrorAccessor
Returns:
The collection ErrorDetails

clear

public void clear()
Description copied from interface: ErrorHandler
Remove all errors from the handler

Specified by:
clear in interface ErrorHandler

removeError

public void removeError(String buildKey,
                        int errorNumber)
Description copied from interface: ErrorHandler
Remove a specific error from the handler.

Specified by:
removeError in interface ErrorHandler
Parameters:
buildKey - The build containing the error
errorNumber - The errorIndex'th error to be associated with the build

getErrorDetails

public ErrorDetails getErrorDetails(String buildKey,
                                    int errorNumber)
Description copied from interface: ErrorHandler
Obtain the specified error from the handler.

Specified by:
getErrorDetails in interface ErrorHandler
Parameters:
buildKey - The build containing the error.
errorNumber - The errorIndex'th error to be associated with the build
Returns:
The error details

removeBuildErrors

public void removeBuildErrors(String buildKey)
Description copied from interface: ErrorHandler
Remove all the errors for a given build

Specified by:
removeBuildErrors in interface ErrorHandler
Parameters:
buildKey - The key of the build


Copyright © 2015 Atlassian Software Systems Pty Ltd. All rights reserved.