Interface PageCopyEvent
-
- All Superinterfaces:
BaseChannelEvent
,PageEvent<PageCopyContext>
,RuntimeExceptionEvent
public interface PageCopyEvent extends PageEvent<PageCopyContext>
PageCopyEvent
which will be put on the internal Guava event bus forsynchronous
events dispatching where listeners to this event can inject logic or short-circuit processing by setting aRuntimeException
throughPageCopyEvent#setException(java.lang.RuntimeException)
. When aRuntimeException
is set on thisPageCopyEvent
by a listener, the org.hippoecm.hst.pagecomposer.jaxrs.services.AbstractConfigResource#publishSynchronousEvent will rethrow the exception. The reason that this has to be done via this PageCopyEvent object is that GuavaEventBus
always catches an exception thrown by a listener, even when injecting a customSubscriberExceptionHandler
Note that listeners for
PageCopyEvent
s must never invokeHstRequestContext#getSession()#save()
. Changes in the JCRSession
will always be persisted by the code that posted thePageCopyEvent
to the guava event bus
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description PageCopyContext
getPageCopyContext()
Deprecated.-
Methods inherited from interface org.hippoecm.hst.pagecomposer.jaxrs.api.BaseChannelEvent
getChannel, getLogger
-
Methods inherited from interface org.hippoecm.hst.pagecomposer.jaxrs.api.PageEvent
getPageActionContext
-
Methods inherited from interface org.hippoecm.hst.pagecomposer.jaxrs.api.RuntimeExceptionEvent
getException, setException
-
-
-
-
Method Detail
-
getPageCopyContext
@Deprecated PageCopyContext getPageCopyContext()
Deprecated.Return the page copy context data.- Returns:
- the page copy context data
-
-