com.gentics.contentnode.rest.resource

Interface LinkCheckerResource

@Path(value="/linkChecker")
public interface LinkCheckerResource

Resource for the link checker

Method Summary

Modifier and Type	Method and Description
CheckResponse	checkLink(CheckExternalLinkRequest request) Check an external link for validity
ExternalLinkResponse	getLink(String pageId, int linkId) Load a single link.
ExternalLinkList	getLinks(String pageId) Get the external links contained in a single page
PageList	getPages(FilterParameterBean filter, SortParameterBean sorting, PagingParameterBean paging, LinkCheckerFilterParameterBean linkFilter, PermsParameterBean perms) Get list of pages containing external links
ExternalLinkStatistics	getStats(Integer nodeId, Boolean online) Get link checker statistics
GenericResponse	updateLink(String pageId, int linkId, long waitMs, ReplaceExternalLinkRequest request) Update a link (optionally together with other occurrences) by replacing the URL with the given URL.
GenericResponse	updateLinkStatus(String pageId, UpdateExternalLinkStatusRequest request) Update the validity status for external links contained in the page.

Method Detail

getStats

@GET
 @Path(value="/stats")
ExternalLinkStatistics getStats(@QueryParam(value="nodeId")
                                                            Integer nodeId,
                                                            @QueryParam(value="online")
                                                            Boolean online)
                                                     throws Exception

Get link checker statistics

Parameters:

nodeId - optional node ID for getting node specific statistics

online - (optional) true to restrict to online pages, false to restrict to offline pages

Returns:

statistics response

Throws:

Exception

getPages

@GET
 @Path(value="/pages")
PageList getPages(@BeanParam
                                              FilterParameterBean filter,
                                              @BeanParam
                                              SortParameterBean sorting,
                                              @BeanParam
                                              PagingParameterBean paging,
                                              @BeanParam
                                              LinkCheckerFilterParameterBean linkFilter,
                                              @BeanParam
                                              PermsParameterBean perms)
                                       throws Exception

Get list of pages containing external links

Parameters:

filter - general filter parameters

sorting - sorting parameters

paging - paging parameters

linkFilter - link filter parameters

perms - permissions parameters

Returns:

response containing a list of pages with external links

Throws:

Exception

getLinks

@GET
 @Path(value="/pages/{id}")
ExternalLinkList getLinks(@PathParam(value="id")
                                                           String pageId)
                                                    throws Exception

Get the external links contained in a single page

Parameters:

pageId - page ID

Returns:

response containing the external links of the page

Throws:

Exception

updateLinkStatus

@POST
 @Path(value="/pages/{id}")
GenericResponse updateLinkStatus(@PathParam(value="id")
                                                                   String pageId,
                                                                   UpdateExternalLinkStatusRequest request)
                                                            throws Exception

Update the validity status for external links contained in the page. Update permissions on the page are required.

Parameters:

pageId - page ID

request - request containing external links with updated status

Returns:

generic response

Throws:

Exception

checkLink

@POST
 @Path(value="/check")
CheckResponse checkLink(CheckExternalLinkRequest request)
                                              throws Exception

Check an external link for validity

Parameters:

request - request containing the link to check

Returns:

check response

Throws:

Exception

getLink

@GET
 @Path(value="/pages/{pageId}/links/{id}")
ExternalLinkResponse getLink(@PathParam(value="pageId")
                                                                             String pageId,
                                                                             @PathParam(value="id")
                                                                             int linkId)
                                                                      throws Exception

Load a single link. Response contains additional information about occurrence of URL in the system

Parameters:

pageId - page ID

linkId - link ID

Returns:

link response

Throws:

Exception

updateLink

@POST
 @Path(value="/pages/{pageId}/links/{id}")
GenericResponse updateLink(@PathParam(value="pageId")
                                                                            String pageId,
                                                                            @PathParam(value="id")
                                                                            int linkId,
                                                                            @QueryParam(value="wait") @DefaultValue(value="0")
                                                                            long waitMs,
                                                                            ReplaceExternalLinkRequest request)
                                                                     throws Exception

Update a link (optionally together with other occurrences) by replacing the URL with the given URL.

Parameters:

pageId - page ID

linkId - link ID

waitMs - time in ms for the request to be done in foreground

request - request containing the new URL and the replace scope

Returns:

response

Throws:

Exception