Package com.composum.sling.core

Interface CoreConfiguration

All Known Implementing Classes:

CoreConfigImpl

public interface CoreConfiguration

The configuration service for all servlets in the core bundle.

Field Summary

Fields

Modifier and Type	Field	Description
static String	ERRORPAGE_STATUS
static String	RESOURCE_PARAMETER	Parameter that can be appended to getLogoutUrl() to save the current rendered resource, to allow re-rendering it after the user logged in.

Method Summary

Modifier and Type	Method	Description
boolean	forwardToErrorpage(org.apache.sling.api.SlingHttpServletRequest request, org.apache.sling.api.SlingHttpServletResponse response, int status)
String	getComposumBase()
org.apache.sling.api.resource.Resource	getErrorpage(org.apache.sling.api.SlingHttpServletRequest request, int status)
@Nullable String	getLoggedoutUrl()	The URL to redirect to after the user was logged out successfully.
default @NotNull String	getLoginUrl()	Deprecated.
@NotNull String	getLoginUrl(@Nullable String targetUri)	Deprecated.
default @NotNull String	getLogoutUrl()	Deprecated.
@NotNull String	getLogoutUrl(@Nullable String targetUri)	The (relative) logout URL (including parameters) to use instead of the default /system/sling/logout.
@NotNull Dictionary<String,Object>	getProperties()	The (readonly) properties useable for extensions.

Field Detail

ERRORPAGE_STATUS

static final String ERRORPAGE_STATUS

See Also:

Constant Field Values

RESOURCE_PARAMETER

static final String RESOURCE_PARAMETER

Parameter that can be appended to getLogoutUrl() to save the current rendered resource, to allow re-rendering it after the user logged in.

See Also:

Constant Field Values

Method Detail

getErrorpage

org.apache.sling.api.resource.Resource getErrorpage(org.apache.sling.api.SlingHttpServletRequest request,
                                                    int status)

forwardToErrorpage

boolean forwardToErrorpage(org.apache.sling.api.SlingHttpServletRequest request,
                           org.apache.sling.api.SlingHttpServletResponse response,
                           int status)
                    throws IOException,
                           javax.servlet.ServletException

Throws:

IOException

javax.servlet.ServletException

getLogoutUrl

@NotNull
@NotNull String getLogoutUrl(@Nullable
                             @Nullable String targetUri)

The (relative) logout URL (including parameters) to use instead of the default /system/sling/logout. A parameter RESOURCE_PARAMETER - the targetUri - can be appended if after user logout the user should be redirected to that target.

getLogoutUrl

@Deprecated
@NotNull
default @NotNull String getLogoutUrl()

Deprecated.

getLoggedoutUrl

@Nullable
@Nullable String getLoggedoutUrl()

The URL to redirect to after the user was logged out successfully.

getLoginUrl

@Deprecated
@NotNull
@NotNull String getLoginUrl(@Nullable
                            @Nullable String targetUri)

Deprecated.

The URL to redirect to when the user should login. A parameter RESOURCE_PARAMETER - the targetUri - can be appended if after user login in the user should redirect to rendering that resource.

getLoginUrl

@Deprecated
@NotNull
default @NotNull String getLoginUrl()

Deprecated.

getProperties

@NotNull
@NotNull Dictionary<String,Object> getProperties()

The (readonly) properties useable for extensions. E.g. introduce a new property in a newer nodes version, and use it if accessible already when depending on an older nodes version.

getComposumBase

String getComposumBase()