com.foreach.across.modules.webcms.domain.article.web

Annotation Type WebCmsArticleMapping

@Target(value={METHOD,TYPE})
 @Retention(value=RUNTIME)
 @Documented
 @WebCmsAssetMapping(value=WebCmsArticle.class)
 @CustomRequestMapping(value=com.foreach.across.modules.webcms.domain.article.web.WebCmsArticleCondition.class)
 @RequestMapping(value="**")
public @interface WebCmsArticleMapping

Mapping for a WebCmsArticle endpoint.

Since:

0.0.2

Author:

Arne Vandamme

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String[]	articleType Article types this mapping applies for.
String[]	domain Mapping will only apply if the current WebCmsDomainContext if for any of the domains specified.
String[]	objectId Globally unique asset object ids.
String[]	publication Publications this mapping applies for.
String[]	publicationType Publication types this mapping applies for.
org.springframework.http.HttpStatus.Series[]	series Mapping will only apply if the WebCmsUrl that it matched on has a status in this series configured.
org.springframework.http.HttpStatus[]	status Mapping will only apply if the WebCmsUrl that it matched on has this status configured.

Element Detail

objectId

public abstract String[] objectId

Globally unique asset object ids. Mapping will only apply for this list of assets.

Default:

{}

status

public abstract org.springframework.http.HttpStatus[] status

Mapping will only apply if the WebCmsUrl that it matched on has this status configured.

Default:

{}

series

public abstract org.springframework.http.HttpStatus.Series[] series

Mapping will only apply if the WebCmsUrl that it matched on has a status in this series configured.

Default:

org.springframework.http.HttpStatus.Series.SUCCESSFUL

articleType

public abstract String[] articleType

Article types this mapping applies for. An article type can be specified either by its WebCmsObjectSuperClass.getObjectId() or WebCmsArticleType#getTypeKey().

Default:

{}

publicationType

public abstract String[] publicationType

Publication types this mapping applies for. A publication type can be specified either by its WebCmsObjectSuperClass.getObjectId() or WebCmsPublicationType#getTypeKey().

Default:

{}

publication

public abstract String[] publication

Publications this mapping applies for. A publication can be specified either by its WebCmsObjectSuperClass.getObjectId() or WebCmsPublication#getPublicationKey().

Note that if publication type is also configured, the match on publication will fail if that publication does not have the publication type.

Default:

{}

domain

@AliasFor(annotation=WebCmsDomainMapping.class,
          attribute="value")
public abstract String[] domain

Mapping will only apply if the current WebCmsDomainContext if for any of the domains specified. If the array of domains is empty, mapping will always apply.

A domain is specified by its domain key, null represent the explicit no-domain.

Default:

{}