Module cool.pandora.ldpclient

Package cool.pandora.ldpclient

Interface LdpClient

All Known Implementing Classes:

LdpClientImpl

public interface LdpClient

LdpClient.

Method Summary

Modifier and Type	Method	Description
void	asyncPut(IRI identifier, InputStream stream)
void	delete(IRI identifier)
Map<String,List<String>>	getAcceptDatetime(IRI identifier, String timestamp)
String	getAcl(IRI identifier, String contentType)
byte[]	getBinary(IRI identifier)
Path	getBinary(IRI identifier, Path file)
String	getBinaryDigest(IRI identifier, String algorithm)
byte[]	getBinaryVersion(IRI identifier, String timestamp)
Path	getBinaryVersion(IRI identifier, Path file, String timestamp)
byte[]	getBytesWithMetadata(IRI identifier, Map<String,String> metadata)
Map<String,List<String>>	getCORS(IRI identifier, IRI origin)
Map<String,List<String>>	getCORSSimple(IRI identifier, IRI origin)
String	getDefaultType(IRI identifier)
String	getJson(IRI identifier)
String	getJsonLDF(IRI identifier, String subject, String predicate, String object)
String	getJsonProfile(IRI identifier, String profile)
String	getJsonProfileLDF(IRI identifier, String profile, String subject, String predicate, String object)
String	getPrefer(IRI identifier, String prefer)
String	getPreferMinimal(IRI identifier)
String	getPreferServerManaged(IRI identifier)
byte[]	getRange(IRI identifier, String byterange)
Map<String,Map<String,List<String>>>	getResponse(IRI identifier, Map<String,String> metadata)
String	getTimeMapJsonProfile(IRI identifier, String profile)
String	getTimeMapLinkDefaultFormat(IRI identifier)
String	getVersionJson(IRI identifier, String profile, String timestamp)
String	getWithContentType(IRI identifier, String contentType)
String	getWithMetadata(IRI identifier, Map<String,String> metadata)
Map<String,List<String>>	head(IRI identifier)
void	multipartDelete(IRI identifier, String sessionId)
void	multipartGet(IRI identifier, String sessionId)
void	multipartOptions(IRI identifier)
void	multipartPost(IRI identifier, InputStream stream, String sessionId)
void	multipartPut(IRI identifier, InputStream stream, String sessionId)
void	multipartStart(IRI identifier, InputStream stream)
void	newLdpDc(IRI identifier, String slug, IRI membershipObj)
void	newLdpDcWithAuth(IRI identifier, String slug, IRI membershipObj, String authorization)
Map<String,List<String>>	options(IRI identifier)
void	patch(IRI identifier, InputStream stream)
void	post(IRI identifier, InputStream stream, String contentType)
void	postBinaryWithDigest(IRI identifier, InputStream stream, String contentType, String digest)
void	postSlug(IRI identifier, String slug, InputStream stream, String contentType)
void	postWithAuth(IRI identifier, InputStream stream, String contentType, String authorization)
void	postWithMetadata(IRI identifier, InputStream stream, Map<String,String> metadata)
void	put(IRI identifier, InputStream stream, String contentType)
void	putBinaryWithDigest(IRI identifier, InputStream stream, String contentType, String digest)
void	putIfMatch(IRI identifier, InputStream stream, String contentType, String etag)
void	putIfUnmodified(IRI identifier, InputStream stream, String contentType, String time)
void	putWithAuth(IRI identifier, InputStream stream, String contentType, String authorization)
void	putWithMetadata(IRI identifier, InputStream stream, Map<String,String> metadata)

Method Detail

head

Map<String,List<String>> head(IRI identifier)
                       throws LdpClientException

Parameters:

identifier - a resource identifier

Returns:

Map of headers

Throws:

LdpClientException - an URISyntaxException, IOException or InterruptedException

getJson

String getJson(IRI identifier)
        throws LdpClientException

Parameters:

identifier - a resource identifier

Returns:

body as a String

Throws:

LdpClientException - an URISyntaxException, IOException or InterruptedException

getDefaultType

String getDefaultType(IRI identifier)
               throws LdpClientException

Parameters:

identifier - a resource identifier

Returns:

body as a String

Throws:

LdpClientException - an URISyntaxException, IOException or InterruptedException

getWithContentType

String getWithContentType(IRI identifier,
                          String contentType)
                   throws LdpClientException

Parameters:

identifier - a resource identifier

contentType - a content type (text/turtle, application/n-triples or application/ld+json)

Returns:

body as a String

Throws:

LdpClientException - an URISyntaxException, IOException or InterruptedException

getAcceptDatetime

Map<String,List<String>> getAcceptDatetime(IRI identifier,
                                           String timestamp)
                                    throws LdpClientException

Parameters:

identifier - a resource identifier

timestamp - an epoch millisecond

Returns:

headers as a Map

Throws:

LdpClientException - an URISyntaxException, IOException or InterruptedException

getTimeMapLinkDefaultFormat

String getTimeMapLinkDefaultFormat(IRI identifier)
                            throws LdpClientException

Parameters:

identifier - a resource identifier

Returns:

body as a String

Throws:

LdpClientException - an URISyntaxException, IOException or InterruptedException

getTimeMapJsonProfile

String getTimeMapJsonProfile(IRI identifier,
                             String profile)
                      throws LdpClientException

Parameters:

identifier - a resource identifier

profile - a JSON-LD profile

Returns:

body as a String

Throws:

LdpClientException - an URISyntaxException, IOException or InterruptedException

See Also:

The JSON-LD Vocabulary

getVersionJson

String getVersionJson(IRI identifier,
                      String profile,
                      String timestamp)
               throws LdpClientException

Parameters:

identifier - a resource identifier

profile - a JSON-LD profile

timestamp - an epoch millisecond

Returns:

body as a String

Throws:

LdpClientException - an URISyntaxException, IOException or InterruptedException

See Also:

The JSON-LD Vocabulary

getBinary

Path getBinary(IRI identifier,
               Path file)
        throws LdpClientException

Parameters:

identifier - a resource identifier

file - an output file as an Path

Returns:

body as a Path

Throws:

LdpClientException - an URISyntaxException, IOException or InterruptedException

getBinary

byte[] getBinary(IRI identifier)
          throws LdpClientException

Parameters:

identifier - a resource identifier

Returns:

body as a byte[]

Throws:

LdpClientException - an URISyntaxException, IOException or InterruptedException

getBinaryDigest

String getBinaryDigest(IRI identifier,
                       String algorithm)
                throws LdpClientException

Parameters:

identifier - a resource identifier

algorithm - a digest algorithm (md5, sha, sha-256 or sha-512)

Returns:

digest as a String

Throws:

LdpClientException - an URISyntaxException, IOException or InterruptedException

getBinaryVersion

Path getBinaryVersion(IRI identifier,
                      Path file,
                      String timestamp)
               throws LdpClientException

Parameters:

identifier - a resource identifier

file - an output file as an Path

timestamp - an epoch millisecond

Returns:

body as a Path

Throws:

LdpClientException - an URISyntaxException, IOException or InterruptedException

getBinaryVersion

byte[] getBinaryVersion(IRI identifier,
                        String timestamp)
                 throws LdpClientException

Parameters:

identifier - a resource identifier

timestamp - an epoch millisecond

Returns:

body as a byte[]

Throws:

LdpClientException - an URISyntaxException, IOException or InterruptedException

getRange

byte[] getRange(IRI identifier,
                String byterange)
         throws LdpClientException

Parameters:

identifier - a resource identifier

byterange - a byterange

Returns:

body as a byte[]

Throws:

LdpClientException - an URISyntaxException, IOException or InterruptedException

getPrefer

String getPrefer(IRI identifier,
                 String prefer)
          throws LdpClientException

Parameters:

identifier - a resource identifier

prefer - an LDP preference

Returns:

body as a String

Throws:

LdpClientException - an URISyntaxException, IOException or InterruptedException

See Also:

7.2 Preferences on the Prefer Request Header

getPreferServerManaged

String getPreferServerManaged(IRI identifier)
                       throws LdpClientException

Parameters:

identifier - a resource identifier

Returns:

body as a String

Throws:

LdpClientException - an URISyntaxException, IOException or InterruptedException

getPreferMinimal

String getPreferMinimal(IRI identifier)
                 throws LdpClientException

Parameters:

identifier - a resource identifier

Returns:

body as a String

Throws:

LdpClientException - an URISyntaxException, IOException or InterruptedException

getJsonProfile

String getJsonProfile(IRI identifier,
                      String profile)
               throws LdpClientException

Parameters:

identifier - a resource identifier

profile - a JSON-LD profile

Returns:

body as a String

Throws:

LdpClientException - an URISyntaxException, IOException or InterruptedException

See Also:

The JSON-LD Vocabulary

getJsonProfileLDF

String getJsonProfileLDF(IRI identifier,
                         String profile,
                         String subject,
                         String predicate,
                         String object)
                  throws LdpClientException

Parameters:

identifier - a resource identifier

profile - a JSON-LD profile

subject - RdfTerm as a String

predicate - RdfTerm as a String

object - RdfTerm as a String

Returns:

body as a String

Throws:

LdpClientException - an URISyntaxException, IOException or InterruptedException

See Also:

The JSON-LD Vocabulary

getJsonLDF

String getJsonLDF(IRI identifier,
                  String subject,
                  String predicate,
                  String object)
           throws LdpClientException

Parameters:

identifier - a resource identifier

subject - RdfTerm as a String

predicate - RdfTerm as a String

object - RdfTerm as a String

Returns:

body as a String

Throws:

LdpClientException - an URISyntaxException, IOException or InterruptedException

getAcl

String getAcl(IRI identifier,
              String contentType)
       throws LdpClientException

Parameters:

identifier - a resource identifier

contentType - a content type as String

Returns:

body as a String

Throws:

LdpClientException - an URISyntaxException, IOException or InterruptedException

getCORS

Map<String,List<String>> getCORS(IRI identifier,
                                 IRI origin)
                          throws LdpClientException

Parameters:

identifier - a resource identifier

origin - a root resource identifier

Returns:

headers as a Map

Throws:

LdpClientException - an URISyntaxException, IOException or InterruptedException

getCORSSimple

Map<String,List<String>> getCORSSimple(IRI identifier,
                                       IRI origin)
                                throws LdpClientException

Parameters:

identifier - a resource identifier

origin - a root resource identifier

Returns:

headers as a Map

Throws:

LdpClientException - an URISyntaxException, IOException or InterruptedException

getWithMetadata

String getWithMetadata(IRI identifier,
                       Map<String,String> metadata)
                throws LdpClientException

Parameters:

identifier - a resource identifier

metadata - a Map of headers

Returns:

body as a String

Throws:

LdpClientException - an URISyntaxException, IOException or InterruptedException

getBytesWithMetadata

byte[] getBytesWithMetadata(IRI identifier,
                            Map<String,String> metadata)
                     throws LdpClientException

Parameters:

identifier - a resource identifier

metadata - a Map of headers

Returns:

body as a byte[]

Throws:

LdpClientException - an URISyntaxException, IOException or InterruptedException

getResponse

Map<String,Map<String,List<String>>> getResponse(IRI identifier,
                                                 Map<String,String> metadata)
                                          throws LdpClientException

Parameters:

identifier - a resource identifier

metadata - a Map of headers

Returns:

body and headers as a Map

Throws:

LdpClientException - an URISyntaxException, IOException or InterruptedException

options

Map<String,List<String>> options(IRI identifier)
                          throws LdpClientException

Parameters:

identifier - a resource identifier

Returns:

headers as a Map

Throws:

LdpClientException - an URISyntaxException, IOException or InterruptedException

post

void post(IRI identifier,
          InputStream stream,
          String contentType)
   throws LdpClientException

Parameters:

identifier - a resource identifier

stream - an InputStream

contentType - a content type

Throws:

LdpClientException - an URISyntaxException, IOException or InterruptedException

postWithMetadata

void postWithMetadata(IRI identifier,
                      InputStream stream,
                      Map<String,String> metadata)
               throws LdpClientException

Parameters:

identifier - a resource identifier

stream - an InputStream

metadata - a Map of headers

Throws:

LdpClientException - an URISyntaxException, IOException or InterruptedException

postWithAuth

void postWithAuth(IRI identifier,
                  InputStream stream,
                  String contentType,
                  String authorization)
           throws LdpClientException

Parameters:

identifier - a resource identifier

stream - an InputStream

contentType - a content type

authorization - an authorization token

Throws:

LdpClientException - an URISyntaxException, IOException or InterruptedException

postSlug

void postSlug(IRI identifier,
              String slug,
              InputStream stream,
              String contentType)
       throws LdpClientException

Parameters:

identifier - a resource identifier

slug - a resource name as a String

stream - an InputStream

contentType - a content type

Throws:

LdpClientException - an URISyntaxException, IOException or InterruptedException

postBinaryWithDigest

void postBinaryWithDigest(IRI identifier,
                          InputStream stream,
                          String contentType,
                          String digest)
                   throws LdpClientException

Parameters:

identifier - a resource identifier

stream - an InputStream

contentType - a content type

digest - a digest as a String

Throws:

LdpClientException - an URISyntaxException, IOException or InterruptedException

See Also:

rfc3230 4.3.2 Digest

newLdpDc

void newLdpDc(IRI identifier,
              String slug,
              IRI membershipObj)
       throws LdpClientException

Parameters:

identifier - a resource identifier

slug - a resource name as a String

membershipObj - a membership Object identifier

Throws:

LdpClientException - an URISyntaxException, IOException or InterruptedException

newLdpDcWithAuth

void newLdpDcWithAuth(IRI identifier,
                      String slug,
                      IRI membershipObj,
                      String authorization)
               throws LdpClientException

Parameters:

identifier - a resource identifier

slug - a resource name as a String

membershipObj - a membership Object identifier

authorization - an authorization token

Throws:

LdpClientException - an URISyntaxException, IOException or InterruptedException

put

void put(IRI identifier,
         InputStream stream,
         String contentType)
  throws LdpClientException

Parameters:

identifier - a resource identifier

stream - an InputStream

contentType - a content type

Throws:

LdpClientException - an URISyntaxException, IOException or InterruptedException

putWithMetadata

void putWithMetadata(IRI identifier,
                     InputStream stream,
                     Map<String,String> metadata)
              throws LdpClientException

Parameters:

identifier - a resource identifier

stream - an InputStream

metadata - a Map of headers

Throws:

LdpClientException - an URISyntaxException, IOException or InterruptedException

putWithAuth

void putWithAuth(IRI identifier,
                 InputStream stream,
                 String contentType,
                 String authorization)
          throws LdpClientException

Parameters:

identifier - a resource identifier

stream - an InputStream

contentType - a content Type as a String

authorization - an authorization token

Throws:

LdpClientException - an URISyntaxException, IOException or InterruptedException

putIfMatch

void putIfMatch(IRI identifier,
                InputStream stream,
                String contentType,
                String etag)
         throws LdpClientException

Parameters:

identifier - a resource identifier

stream - an InputStream

contentType - a content type

etag - a strong Etag as a String

Throws:

LdpClientException - an URISyntaxException, IOException or InterruptedException

putBinaryWithDigest

void putBinaryWithDigest(IRI identifier,
                         InputStream stream,
                         String contentType,
                         String digest)
                  throws LdpClientException

Parameters:

identifier - a resource identifier

stream - an InputStream

contentType - a content type

digest - a digest as a String

Throws:

LdpClientException - an URISyntaxException, IOException or InterruptedException

See Also:

rfc3230 4.3.2 Digest

putIfUnmodified

void putIfUnmodified(IRI identifier,
                     InputStream stream,
                     String contentType,
                     String time)
              throws LdpClientException

Parameters:

identifier - a resource identifier

stream - an InputStream

contentType - a content type

time - an RFC_1123_DATE_TIME as an String

Throws:

LdpClientException - an URISyntaxException, IOException or InterruptedException

delete

void delete(IRI identifier)
     throws LdpClientException

Parameters:

identifier - a resource identifier

Throws:

LdpClientException - an URISyntaxException, IOException or InterruptedException

patch

void patch(IRI identifier,
           InputStream stream)
    throws LdpClientException

Parameters:

identifier - a resource identifier

stream - an InputStream

Throws:

LdpClientException - an URISyntaxException, IOException or InterruptedException

multipartOptions

void multipartOptions(IRI identifier)

Parameters:

identifier - a resource identifier

multipartStart

void multipartStart(IRI identifier,
                    InputStream stream)

Parameters:

identifier - a resource identifier

stream - an InputStream

multipartGet

void multipartGet(IRI identifier,
                  String sessionId)

Parameters:

identifier - a resource identifier

sessionId - a session identifier

multipartPut

void multipartPut(IRI identifier,
                  InputStream stream,
                  String sessionId)

Parameters:

identifier - a resource identifier

stream - an InputStream

sessionId - a session identifier

multipartPost

void multipartPost(IRI identifier,
                   InputStream stream,
                   String sessionId)

Parameters:

identifier - a resource identifier

stream - an InputStream

sessionId - a session identifier

multipartDelete

void multipartDelete(IRI identifier,
                     String sessionId)

Parameters:

identifier - a resource identifier

sessionId - a session identifier

asyncPut

void asyncPut(IRI identifier,
              InputStream stream)
       throws LdpClientException

Parameters:

identifier - a resource identifier

stream - an InputStream

Throws:

LdpClientException - an URISyntaxException