flexagon.fd.services.groovy.functions

Class LogFunctions

java.lang.Object

flexagon.fd.services.groovy.functions.BaseFunctions

flexagon.fd.services.groovy.functions.LogFunctions

Direct Known Subclasses:

WebhookLogFunctions

public class LogFunctions
extends BaseFunctions

Log Functions for logging messages and capturing status messages

Since:

5.3

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	GROOVY_KEY

Fields inherited from class flexagon.fd.services.groovy.functions.BaseFunctions

mExecute, mFLOG, mScriptRef

Constructor Summary

Constructors

Constructor and Description
LogFunctions(boolean isExecute)

Method Summary

Modifier and Type	Method and Description
void	addSecureLogValues(java.lang.String pSecureValue)
void	cleanup()
void	fine(java.lang.String pMessage) Logs a message to the FlexDeploy logs with a level of FINE.
void	fine(java.lang.String pMessage, java.lang.Throwable pThrowable) Logs a message to the FlexDeploy logs with a level of FINE.
java.lang.String	getGroovyKey()
java.util.List<LogMessage>	getLogs()
java.lang.String	getMessage()
java.lang.Long	getObjectId()
FlexDeploySecurityConstants.SecurityObjectType	getObjectType()
java.lang.Long	getParentObjectId()
void	info(java.lang.String pMessage) Logs a message to the FlexDeploy logs with a level of INFO.
void	info(java.lang.String pMessage, java.lang.Throwable pThrowable) Logs a message to the FlexDeploy logs with a level of INFO.
void	setLogKey(java.lang.String pLogKey)
void	setMessage(java.lang.String pMessage) Sets the message shown for current webhook execution on the Webhook Messages screen.
void	setMessage(java.lang.String pMessage, boolean overwrite) Sets the message shown for current webhook execution on the Webhook Messages screen.
void	setObjectId(java.lang.Long pObjectId)
void	setObjectType(FlexDeploySecurityConstants.SecurityObjectType pObjectType)
void	setParentObjectId(java.lang.Long pParentObjectId)
void	setSecureLogValues(java.util.List<java.lang.String> pSecureValues)
void	severe(java.lang.String pMessage) Logs a message to the FlexDeploy logs with a level of SEVERE.
void	severe(java.lang.String pMessage, java.lang.Throwable pThrowable) Logs a message to the FlexDeploy logs with a level of SEVERE.
void	warning(java.lang.String pMessage) Logs a message to the FlexDeploy logs with a level of WARNING.
void	warning(java.lang.String pMessage, java.lang.Throwable pThrowable) Logs a message to the FlexDeploy logs with a level of WARNING.

Methods inherited from class flexagon.fd.services.groovy.functions.BaseFunctions

captureSecureValuesForLogFunction, decryptIntegrationInstance, doSimpleGet, findIntegrationInstanceByCode, getLogFunctions, getServerBaseUrl, setScriptRef

Methods inherited from class java.lang.Object

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

Field Detail

GROOVY_KEY

public static final java.lang.String GROOVY_KEY

See Also:

Constant Field Values

Constructor Detail

LogFunctions

public LogFunctions(boolean isExecute)

Method Detail

setObjectId

public void setObjectId(java.lang.Long pObjectId)

getObjectId

public java.lang.Long getObjectId()

setParentObjectId

public void setParentObjectId(java.lang.Long pParentObjectId)

getParentObjectId

public java.lang.Long getParentObjectId()

setObjectType

public void setObjectType(FlexDeploySecurityConstants.SecurityObjectType pObjectType)

getObjectType

public FlexDeploySecurityConstants.SecurityObjectType getObjectType()

setMessage

public void setMessage(java.lang.String pMessage)

Sets the message shown for current webhook execution on the Webhook Messages screen. Message will be overwritten if there are any errors during execution. Using this function will also write an info level log

Parameters:

pMessage - Message to set. e.g. "Branch abc created" or "Projects 1 and 2 built"

setMessage

public void setMessage(java.lang.String pMessage,
                       boolean overwrite)

Sets the message shown for current webhook execution on the Webhook Messages screen. Message will be overwritten if there are any errors during execution. This overload accepts an additional argument to overwrite the previous message (if any).

Parameters:

pMessage - Message to set. e.g. "Branch abc created" or "Projects 1 and 2 built"

overwrite - If a message is already set, should it be overwritten with this message

Since:

5.5.0.2

info

public void info(java.lang.String pMessage)

Logs a message to the FlexDeploy logs with a level of INFO. These logs will be added to the FlexDeploy logs in addition to the Webhook log table shown in Webhook Messages

Parameters:

pMessage - The message to log

info

public void info(java.lang.String pMessage,
                 java.lang.Throwable pThrowable)

Logs a message to the FlexDeploy logs with a level of INFO. These logs will be added to the FlexDeploy logs in addition to the Webhook log table shown in Webhook Messages

Parameters:

pMessage - The message to log

pThrowable - Throwable error to log

fine

public void fine(java.lang.String pMessage)

Logs a message to the FlexDeploy logs with a level of FINE. These logs will be added to the FlexDeploy logs in addition to the Webhook log table shown in Webhook Messages

Parameters:

pMessage - The message to log

fine

public void fine(java.lang.String pMessage,
                 java.lang.Throwable pThrowable)

Logs a message to the FlexDeploy logs with a level of FINE. These logs will be added to the FlexDeploy logs in addition to the Webhook log table shown in Webhook Messages

Parameters:

pMessage - The message to log

pThrowable - Throwable error to log

warning

public void warning(java.lang.String pMessage)

Logs a message to the FlexDeploy logs with a level of WARNING. These logs will be added to the FlexDeploy logs in addition to the Webhook log table shown in Webhook Messages

Parameters:

pMessage - The message to log

warning

public void warning(java.lang.String pMessage,
                    java.lang.Throwable pThrowable)

Logs a message to the FlexDeploy logs with a level of WARNING. These logs will be added to the FlexDeploy logs in addition to the Webhook log table shown in Webhook Messages

Parameters:

pMessage - The message to log

pThrowable - Throwable error to log

severe

public void severe(java.lang.String pMessage)

Logs a message to the FlexDeploy logs with a level of SEVERE. These logs will be added to the FlexDeploy logs in addition to the Webhook log table shown in Webhook Messages

Parameters:

pMessage - The message to log

severe

public void severe(java.lang.String pMessage,
                   java.lang.Throwable pThrowable)

Logs a message to the FlexDeploy logs with a level of SEVERE. These logs will be added to the FlexDeploy logs in addition to the Webhook log table shown in Webhook Messages

Parameters:

pMessage - The message to log

pThrowable - Throwable error to log

getLogs

public java.util.List<LogMessage> getLogs()

getMessage

public java.lang.String getMessage()

getGroovyKey

public java.lang.String getGroovyKey()

Specified by:

getGroovyKey in class BaseFunctions

setLogKey

public void setLogKey(java.lang.String pLogKey)

setSecureLogValues

public void setSecureLogValues(java.util.List<java.lang.String> pSecureValues)

addSecureLogValues

public void addSecureLogValues(java.lang.String pSecureValue)

cleanup

public void cleanup()

Specified by:

cleanup in class BaseFunctions