org.apache.tika.server.resource

Class TikaResource

java.lang.Object

org.apache.tika.server.resource.TikaResource

@Path(value="/tika")
public class TikaResource
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	GREETING
static String	PASSWORD
static String	PASSWORD_BASE64_UTF8
static String	X_TIKA_OCR_HEADER_PREFIX
static String	X_TIKA_PDF_HEADER_PREFIX
static String	X_TIKA_SKIP_EMBEDDED_HEADER

Constructor Summary

Constructors

Constructor and Description
TikaResource()

Method Summary

Modifier and Type	Method and Description
static void	checkIsOperating()
static Parser	createParser()
static String	detectFilename(javax.ws.rs.core.MultivaluedMap<String,String> httpHeaders)
static void	fillMetadata(Parser parser, Metadata metadata, ParseContext context, javax.ws.rs.core.MultivaluedMap<String,String> httpHeaders)
static void	fillParseContext(ParseContext parseContext, javax.ws.rs.core.MultivaluedMap<String,String> httpHeaders, Parser embeddedParser) Fills the parse context.
static TikaConfig	getConfig()
static Detector	getDetector(Parser p)
javax.ws.rs.core.StreamingOutput	getHTML(InputStream is, javax.ws.rs.core.HttpHeaders httpHeaders, javax.ws.rs.core.UriInfo info)
javax.ws.rs.core.StreamingOutput	getHTMLFromMultipart(org.apache.cxf.jaxrs.ext.multipart.Attachment att, javax.ws.rs.core.HttpHeaders httpHeaders, javax.ws.rs.core.UriInfo info)
static InputStream	getInputStream(InputStream is, Metadata metadata, javax.ws.rs.core.HttpHeaders headers)
Metadata	getJson(InputStream is, javax.ws.rs.core.HttpHeaders httpHeaders, javax.ws.rs.core.UriInfo info, String handlerTypeName)
Metadata	getJsonFromMultipart(org.apache.cxf.jaxrs.ext.multipart.Attachment att, javax.ws.rs.core.HttpHeaders httpHeaders, javax.ws.rs.core.UriInfo info, String handlerTypeName)
String	getMessage()
javax.ws.rs.core.StreamingOutput	getText(InputStream is, javax.ws.rs.core.HttpHeaders httpHeaders, javax.ws.rs.core.UriInfo info)
javax.ws.rs.core.StreamingOutput	getTextFromMultipart(org.apache.cxf.jaxrs.ext.multipart.Attachment att, javax.ws.rs.core.HttpHeaders httpHeaders, javax.ws.rs.core.UriInfo info)
javax.ws.rs.core.StreamingOutput	getTextMain(InputStream is, javax.ws.rs.core.HttpHeaders httpHeaders, javax.ws.rs.core.UriInfo info)
javax.ws.rs.core.StreamingOutput	getTextMainFromMultipart(org.apache.cxf.jaxrs.ext.multipart.Attachment att, javax.ws.rs.core.HttpHeaders httpHeaders, javax.ws.rs.core.UriInfo info)
javax.ws.rs.core.StreamingOutput	getXML(InputStream is, javax.ws.rs.core.HttpHeaders httpHeaders, javax.ws.rs.core.UriInfo info)
javax.ws.rs.core.StreamingOutput	getXMLFromMultipart(org.apache.cxf.jaxrs.ext.multipart.Attachment att, javax.ws.rs.core.HttpHeaders httpHeaders, javax.ws.rs.core.UriInfo info)
static void	init(TikaConfig config, boolean includeStackTrace, DigestingParser.Digester digestr, InputStreamFactory iSF, ServerStatus serverStatus)
static void	logRequest(org.slf4j.Logger logger, javax.ws.rs.core.UriInfo info, Metadata metadata)
static void	parse(Parser parser, org.slf4j.Logger logger, String path, InputStream inputStream, ContentHandler handler, Metadata metadata, ParseContext parseContext) Use this to call a parser and unify exception handling.
javax.ws.rs.core.StreamingOutput	produceText(InputStream is, Metadata metadata, javax.ws.rs.core.MultivaluedMap<String,String> httpHeaders, javax.ws.rs.core.UriInfo info)
javax.ws.rs.core.StreamingOutput	produceTextMain(InputStream is, javax.ws.rs.core.MultivaluedMap<String,String> httpHeaders, javax.ws.rs.core.UriInfo info)
static void	setDetector(Parser p, Detector detector)

Methods inherited from class java.lang.Object

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

Field Detail

GREETING

public static final String GREETING

X_TIKA_OCR_HEADER_PREFIX

public static final String X_TIKA_OCR_HEADER_PREFIX

See Also:

Constant Field Values

X_TIKA_PDF_HEADER_PREFIX

public static final String X_TIKA_PDF_HEADER_PREFIX

See Also:

Constant Field Values

X_TIKA_SKIP_EMBEDDED_HEADER

public static final String X_TIKA_SKIP_EMBEDDED_HEADER

See Also:

Constant Field Values

PASSWORD

public static final String PASSWORD

See Also:

Constant Field Values

PASSWORD_BASE64_UTF8

public static final String PASSWORD_BASE64_UTF8

See Also:

Constant Field Values

Constructor Detail

TikaResource

public TikaResource()

Method Detail

init

public static void init(TikaConfig config,
                        boolean includeStackTrace,
                        DigestingParser.Digester digestr,
                        InputStreamFactory iSF,
                        ServerStatus serverStatus)

createParser

public static Parser createParser()

getConfig

public static TikaConfig getConfig()

detectFilename

public static String detectFilename(javax.ws.rs.core.MultivaluedMap<String,String> httpHeaders)

fillParseContext

public static void fillParseContext(ParseContext parseContext,
                                    javax.ws.rs.core.MultivaluedMap<String,String> httpHeaders,
                                    Parser embeddedParser)

Fills the parse context.

Parameters:

parseContext - the parse context to fil.

httpHeaders - the HTTP headers for the request.

embeddedParser - the embedded parser.

getInputStream

public static InputStream getInputStream(InputStream is,
                                         Metadata metadata,
                                         javax.ws.rs.core.HttpHeaders headers)

fillMetadata

public static void fillMetadata(Parser parser,
                                Metadata metadata,
                                ParseContext context,
                                javax.ws.rs.core.MultivaluedMap<String,String> httpHeaders)

setDetector

public static void setDetector(Parser p,
                               Detector detector)

getDetector

public static Detector getDetector(Parser p)

parse

public static void parse(Parser parser,
                         org.slf4j.Logger logger,
                         String path,
                         InputStream inputStream,
                         ContentHandler handler,
                         Metadata metadata,
                         ParseContext parseContext)
                  throws IOException

Use this to call a parser and unify exception handling. NOTE: This call to parse closes the InputStream. DO NOT surround the call in an auto-close block.

Parameters:

parser - parser to use

logger - logger to use

path - file path

inputStream - inputStream (which is closed by this call!)

handler - handler to use

metadata - metadata

parseContext - parse context

Throws:

IOException - wrapper for all exceptions

checkIsOperating

public static void checkIsOperating()

logRequest

public static void logRequest(org.slf4j.Logger logger,
                              javax.ws.rs.core.UriInfo info,
                              Metadata metadata)

getMessage

@GET
 @Produces(value="text/plain")
public String getMessage()

getTextFromMultipart

@POST
 @Consumes(value="multipart/form-data")
 @Produces(value="text/plain")
 @Path(value="form")
public javax.ws.rs.core.StreamingOutput getTextFromMultipart(org.apache.cxf.jaxrs.ext.multipart.Attachment att,
                                                                                                                                                               @Context
                                                                                                                                                               javax.ws.rs.core.HttpHeaders httpHeaders,
                                                                                                                                                               @Context
                                                                                                                                                               javax.ws.rs.core.UriInfo info)

getTextMain

@PUT
 @Consumes(value="*/*")
 @Produces(value="text/plain")
 @Path(value="main")
public javax.ws.rs.core.StreamingOutput getTextMain(InputStream is,
                                                                                                                                     @Context
                                                                                                                                     javax.ws.rs.core.HttpHeaders httpHeaders,
                                                                                                                                     @Context
                                                                                                                                     javax.ws.rs.core.UriInfo info)

getTextMainFromMultipart

@POST
 @Consumes(value="multipart/form-data")
 @Produces(value="text/plain")
 @Path(value="form/main")
public javax.ws.rs.core.StreamingOutput getTextMainFromMultipart(org.apache.cxf.jaxrs.ext.multipart.Attachment att,
                                                                                                                                                                        @Context
                                                                                                                                                                        javax.ws.rs.core.HttpHeaders httpHeaders,
                                                                                                                                                                        @Context
                                                                                                                                                                        javax.ws.rs.core.UriInfo info)

produceTextMain

public javax.ws.rs.core.StreamingOutput produceTextMain(InputStream is,
                                                        javax.ws.rs.core.MultivaluedMap<String,String> httpHeaders,
                                                        javax.ws.rs.core.UriInfo info)

getText

@PUT
 @Consumes(value="*/*")
 @Produces(value="text/plain")
public javax.ws.rs.core.StreamingOutput getText(InputStream is,
                                                                                                            @Context
                                                                                                            javax.ws.rs.core.HttpHeaders httpHeaders,
                                                                                                            @Context
                                                                                                            javax.ws.rs.core.UriInfo info)

produceText

public javax.ws.rs.core.StreamingOutput produceText(InputStream is,
                                                    Metadata metadata,
                                                    javax.ws.rs.core.MultivaluedMap<String,String> httpHeaders,
                                                    javax.ws.rs.core.UriInfo info)

getHTMLFromMultipart

@POST
 @Consumes(value="multipart/form-data")
 @Produces(value="text/html")
 @Path(value="form")
public javax.ws.rs.core.StreamingOutput getHTMLFromMultipart(org.apache.cxf.jaxrs.ext.multipart.Attachment att,
                                                                                                                                                              @Context
                                                                                                                                                              javax.ws.rs.core.HttpHeaders httpHeaders,
                                                                                                                                                              @Context
                                                                                                                                                              javax.ws.rs.core.UriInfo info)

getHTML

@PUT
 @Consumes(value="*/*")
 @Produces(value="text/html")
public javax.ws.rs.core.StreamingOutput getHTML(InputStream is,
                                                                                                           @Context
                                                                                                           javax.ws.rs.core.HttpHeaders httpHeaders,
                                                                                                           @Context
                                                                                                           javax.ws.rs.core.UriInfo info)

getXMLFromMultipart

@POST
 @Consumes(value="multipart/form-data")
 @Produces(value="text/xml")
 @Path(value="form")
public javax.ws.rs.core.StreamingOutput getXMLFromMultipart(org.apache.cxf.jaxrs.ext.multipart.Attachment att,
                                                                                                                                                            @Context
                                                                                                                                                            javax.ws.rs.core.HttpHeaders httpHeaders,
                                                                                                                                                            @Context
                                                                                                                                                            javax.ws.rs.core.UriInfo info)

getXML

@PUT
 @Consumes(value="*/*")
 @Produces(value="text/xml")
public javax.ws.rs.core.StreamingOutput getXML(InputStream is,
                                                                                                         @Context
                                                                                                         javax.ws.rs.core.HttpHeaders httpHeaders,
                                                                                                         @Context
                                                                                                         javax.ws.rs.core.UriInfo info)

getJsonFromMultipart

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

Throws:

IOException

TikaException

getJson

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

Throws:

IOException

TikaException