software.amazon.cloudformation.proxy.hook

Class HookProgressEvent<CallbackT>

java.lang.Object

software.amazon.cloudformation.proxy.hook.HookProgressEvent<CallbackT>

public class HookProgressEvent<CallbackT>
extends Object

Constructor Summary

Constructors

Constructor and Description
HookProgressEvent()

Method Summary

Modifier and Type	Method and Description
boolean	canContinueProgress()
static <CallbackT> HookProgressEvent<CallbackT>	complete(CallbackT cxt, String message, String data)
static <CallbackT> HookProgressEvent<CallbackT>	defaultCompleteHandler() Convenience method for constructing a SUCCESS response
static <CallbackT> HookProgressEvent<CallbackT>	defaultFailureHandler(Throwable e, HandlerErrorCode handlerErrorCode) Convenience method for constructing a FAILED response
static <CallbackT> HookProgressEvent<CallbackT>	defaultProgressHandler(CallbackT cxt, int delaySeconds) Convenience method for constructing a IN_PROGRESS response
static <CallbackT> HookProgressEvent<CallbackT>	failed(CallbackT cxt, HandlerErrorCode code, String message, String data)
boolean	isComplete()
boolean	isFailed()
boolean	isInProgress()
boolean	isInProgressCallbackDelay()
HookProgressEvent<CallbackT>	onComplete(Function<HookProgressEvent<CallbackT>,HookProgressEvent<CallbackT>> func)
static <CallbackT> HookProgressEvent<CallbackT>	progress(CallbackT cxt, String message, String data, int delaySeconds)
HookProgressEvent<CallbackT>	then(Function<HookProgressEvent<CallbackT>,HookProgressEvent<CallbackT>> func)

Methods inherited from class java.lang.Object

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

Constructor Detail

HookProgressEvent

public HookProgressEvent()

Method Detail

defaultFailureHandler

public static <CallbackT> HookProgressEvent<CallbackT> defaultFailureHandler(Throwable e,
                                                                             HandlerErrorCode handlerErrorCode)

Convenience method for constructing a FAILED response

Type Parameters:

CallbackT - the type for the callback context

Parameters:

e - actual service exception

handlerErrorCode - error code to return to CloudFormation

Returns:

HookProgressEvent failed status code

failed

public static <CallbackT> HookProgressEvent<CallbackT> failed(CallbackT cxt,
                                                              HandlerErrorCode code,
                                                              String message,
                                                              String data)

defaultProgressHandler

public static <CallbackT> HookProgressEvent<CallbackT> defaultProgressHandler(CallbackT cxt,
                                                                              int delaySeconds)

Convenience method for constructing a IN_PROGRESS response

Type Parameters:

CallbackT - The type for the callback context

Parameters:

cxt - callback context

delaySeconds - how much time to wait before calling back the handler

Returns:

HookProgressEvent with HookStatus.IN_PROGRESS

progress

public static <CallbackT> HookProgressEvent<CallbackT> progress(CallbackT cxt,
                                                                String message,
                                                                String data,
                                                                int delaySeconds)

defaultCompleteHandler

public static <CallbackT> HookProgressEvent<CallbackT> defaultCompleteHandler()

Convenience method for constructing a SUCCESS response

Type Parameters:

CallbackT - The type for the callback context

Returns:

HookProgressEvent with HookStatus.SUCCESS indicating successful completion for operation

complete

public static <CallbackT> HookProgressEvent<CallbackT> complete(CallbackT cxt,
                                                                String message,
                                                                String data)

onComplete

public HookProgressEvent<CallbackT> onComplete(Function<HookProgressEvent<CallbackT>,HookProgressEvent<CallbackT>> func)

isFailed

public boolean isFailed()

isInProgress

public boolean isInProgress()

canContinueProgress

public boolean canContinueProgress()

then

public HookProgressEvent<CallbackT> then(Function<HookProgressEvent<CallbackT>,HookProgressEvent<CallbackT>> func)

isComplete

public boolean isComplete()

isInProgressCallbackDelay

public boolean isInProgressCallbackDelay()