org.apache.tika.server

Class MetadataEP

java.lang.Object

org.apache.tika.server.MetadataEP

@Path(value="/metadata")
public class MetadataEP
extends Object

This JAX-RS endpoint provides access to the metadata contained within a document. It is possible to submit a relatively small prefix (a few KB) of a document's content to retrieve individual metadata fields.

Constructor Summary

Constructors

Constructor and Description
MetadataEP(javax.ws.rs.core.HttpHeaders httpHeaders, javax.ws.rs.core.UriInfo info)

Method Summary

Methods

Modifier and Type	Method and Description
javax.ws.rs.core.Response	getMetadata(InputStream is) Get all metadata that can be parsed from the specified input stream.
javax.ws.rs.core.Response	getMetadataField(String field, InputStream is) Get a specific metadata field.
javax.ws.rs.core.Response	getSimpleMetadataField(String field, InputStream is) Get a specific TIKA metadata field as a simple text string.

Methods inherited from class java.lang.Object

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

Constructor Detail

MetadataEP

public MetadataEP(@Context
          javax.ws.rs.core.HttpHeaders httpHeaders,
          @Context
          javax.ws.rs.core.UriInfo info)

Method Detail

getMetadata

public javax.ws.rs.core.Response getMetadata(InputStream is)
                                      throws Exception

Get all metadata that can be parsed from the specified input stream. An error is produced if the input stream cannot be parsed.

Parameters:

is - an input stream

Returns:

the metadata

Throws:

Exception

getSimpleMetadataField

@Path(value="{field}")
public javax.ws.rs.core.Response getSimpleMetadataField(String field,
                                                    InputStream is)
                                                 throws Exception

Get a specific TIKA metadata field as a simple text string. If the field is multivalued, then only the first value is returned. If the input stream cannot be parsed, but a value was found for the given metadata field, then the value of the field is returned as part of a 200 OK response; otherwise a Response.Status.BAD_REQUEST is generated. If the stream was successfully parsed but the specific metadata field was not found, then a Response.Status.NOT_FOUND is returned.

Parameters:

field - the tika metadata field name

is - the document stream

Returns:

one of Response.Status.OK, Response.Status.NOT_FOUND, or Response.Status.BAD_REQUEST

Throws:

Exception

getMetadataField

@Path(value="{field}")
public javax.ws.rs.core.Response getMetadataField(String field,
                                              InputStream is)
                                           throws Exception

Get a specific metadata field. If the input stream cannot be parsed, but a value was found for the given metadata field, then the value of the field is returned as part of a 200 OK response; otherwise a Response.Status.BAD_REQUEST is generated. If the stream was successfully parsed but the specific metadata field was not found, then a Response.Status.NOT_FOUND is returned.

Note that this method handles multivalue fields and returns possibly more metadata than requested.

Parameters:

field - the tika metadata field name

is - the document stream

Returns:

one of Response.Status.OK, Response.Status.NOT_FOUND, or Response.Status.BAD_REQUEST

Throws:

Exception