org.lockss.laaws.rs.impl

Class CdxApiServiceImpl

java.lang.Object

org.lockss.laaws.rs.impl.CdxApiServiceImpl

All Implemented Interfaces:

CdxApiDelegate

@Service
public class CdxApiServiceImpl
extends Object
implements CdxApiDelegate

Service for providing CDX records.

Constructor Summary

Constructors

Constructor and Description
CdxApiServiceImpl(javax.servlet.http.HttpServletRequest request) Constructor for autowiring.

Method Summary

Modifier and Type	Method and Description
org.springframework.http.ResponseEntity<String>	getCdxOwb(String collectionid, String q, Integer count, Integer startPage, String accept, String acceptEncoding) Provides the OpenWayback CDX records of a URL in a collection.
org.springframework.http.ResponseEntity<String>	getCdxPywb(String collectionid, String url, Integer limit, String matchType, String sort, String closest, String output, String fl, String accept, String acceptEncoding) Provides the PyWayback CDX records of a URL in a collection.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.lockss.laaws.rs.api.CdxApiDelegate

getAcceptHeader, getObjectMapper, getRequest

Constructor Detail

CdxApiServiceImpl

@Autowired
public CdxApiServiceImpl(javax.servlet.http.HttpServletRequest request)

Constructor for autowiring.

Parameters:

request - An HttpServletRequest with the HTTP request.

Method Detail

getCdxOwb

public org.springframework.http.ResponseEntity<String> getCdxOwb(String collectionid,
                                                                 String q,
                                                                 Integer count,
                                                                 Integer startPage,
                                                                 String accept,
                                                                 String acceptEncoding)

Provides the OpenWayback CDX records of a URL in a collection.

Specified by:

getCdxOwb in interface CdxApiDelegate

Parameters:

collectionid - A String with the identifier of the collection.

q - A String with the query string. Supported fields are url, type (urlquery/prefixquery), offset, limit, request.anchordate, startdate and enddate.

count - An Integer with the count of results per page to be returned.

startPage - An Integer with the page number of results, 1 based.

accept - A String with the Accept request header.

acceptEncoding - A String with the Accept-Encoding request header.

Returns:

a ResponseEntity<String> with the requested OpenWayback CDX records.

See Also:

CdxApi.getCdxOwb(java.lang.String, java.lang.String, java.lang.Integer, java.lang.Integer, java.lang.String, java.lang.String)

getCdxPywb

public org.springframework.http.ResponseEntity<String> getCdxPywb(String collectionid,
                                                                  String url,
                                                                  Integer limit,
                                                                  String matchType,
                                                                  String sort,
                                                                  String closest,
                                                                  String output,
                                                                  String fl,
                                                                  String accept,
                                                                  String acceptEncoding)

Provides the PyWayback CDX records of a URL in a collection.

Specified by:

getCdxPywb in interface CdxApiDelegate

Parameters:

collectionid - A String with the identifier of the collection.

url - A String with the URL for which the CDX records are requested.

limit - An Integer with the limit.

matchType - A String with the type of match requested.

sort - A String with the type of sort requested.

closest - A String with the timestamp for the sort=closest mode.

output - A String with the output format requested.

fl - A String with the comma-separated list of fields to include in the result.

accept - A String with the Accept request header.

acceptEncoding - A String with the Accept-Encoding request header.

Returns:

a ResponseEntity<String> with the requested PyWayback CDX records.

See Also:

CdxApi.getCdxPywb(java.lang.String, java.lang.String, java.lang.Integer, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)