org.apache.tika.server.resource

Class RecursiveMetadataResource

java.lang.Object

org.apache.tika.server.resource.RecursiveMetadataResource

@Path(value="/rmeta")
public class RecursiveMetadataResource
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected static BasicContentHandlerFactory.HANDLER_TYPE	DEFAULT_HANDLER_TYPE
protected static String	HANDLER_TYPE_PARAM

Constructor Summary

Constructors

Constructor and Description
RecursiveMetadataResource()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	getMetadata(InputStream is, javax.ws.rs.core.HttpHeaders httpHeaders, javax.ws.rs.core.UriInfo info, String handlerTypeName) Returns an InputStream that can be deserialized as a list of Metadata objects.
javax.ws.rs.core.Response	getMetadataFromMultipart(org.apache.cxf.jaxrs.ext.multipart.Attachment att, javax.ws.rs.core.UriInfo info, String handlerTypeName) Returns an InputStream that can be deserialized as a list of Metadata objects.

Methods inherited from class java.lang.Object

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

Field Detail

HANDLER_TYPE_PARAM

protected static final String HANDLER_TYPE_PARAM

See Also:

Constant Field Values

DEFAULT_HANDLER_TYPE

protected static final BasicContentHandlerFactory.HANDLER_TYPE DEFAULT_HANDLER_TYPE

Constructor Detail

RecursiveMetadataResource

public RecursiveMetadataResource()

Method Detail

getMetadataFromMultipart

@POST
 @Consumes(value="multipart/form-data")
 @Produces(value="application/json")
 @Path(value="form{handler : (\\w+)?}")
public javax.ws.rs.core.Response getMetadataFromMultipart(org.apache.cxf.jaxrs.ext.multipart.Attachment att,
                                                                                                                                                                                     @Context
                                                                                                                                                                                     javax.ws.rs.core.UriInfo info,
                                                                                                                                                                                     @PathParam(value="handler")
                                                                                                                                                                                     String handlerTypeName)
                                                                                                                                                                              throws Exception

Returns an InputStream that can be deserialized as a list of Metadata objects. The first in the list represents the main document, and the rest represent metadata for the embedded objects. This works recursively through all descendants of the main document, not just the immediate children.

The extracted text content is stored with the key RecursiveParserWrapper.TIKA_CONTENT.

Specify the handler for the content (xml, html, text, ignore) in the path:
/rmeta/form (default: xml)
/rmeta/form/xml (store the content as xml)
/rmeta/form/text (store the content as text)
/rmeta/form/ignore (don't record any content)

Parameters:

att - attachment

info - uri info

handlerTypeName - which type of handler to use

Returns:

InputStream that can be deserialized as a list of Metadata objects

Throws:

Exception

getMetadata

@PUT
 @Produces(value="application/json")
 @Path(value="{handler : (\\w+)?}")
public javax.ws.rs.core.Response getMetadata(InputStream is,
                                                                                                                           @Context
                                                                                                                           javax.ws.rs.core.HttpHeaders httpHeaders,
                                                                                                                           @Context
                                                                                                                           javax.ws.rs.core.UriInfo info,
                                                                                                                           @PathParam(value="handler")
                                                                                                                           String handlerTypeName)
                                                                                                                    throws Exception

Returns an InputStream that can be deserialized as a list of Metadata objects. The first in the list represents the main document, and the rest represent metadata for the embedded objects. This works recursively through all descendants of the main document, not just the immediate children.

The extracted text content is stored with the key RecursiveParserWrapper.TIKA_CONTENT.

Specify the handler for the content (xml, html, text, ignore) in the path:
/rmeta (default: xml)
/rmeta/xml (store the content as xml)
/rmeta/text (store the content as text)
/rmeta/ignore (don't record any content)

Parameters:

info - uri info

handlerTypeName - which type of handler to use

Returns:

InputStream that can be deserialized as a list of Metadata objects

Throws:

Exception