Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.apache.stanbol.contenthub.web.resources
Class SemanticIndexManagerResource

java.lang.Object
  extended by org.apache.stanbol.commons.web.base.resource.BaseStanbolResource
      extended by org.apache.stanbol.contenthub.web.resources.SemanticIndexManagerResource

public class SemanticIndexManagerResource
extends org.apache.stanbol.commons.web.base.resource.BaseStanbolResource

This class the the web resource to handle the RESTful requests and HTML view of the LDProgram management facilities within Contenthub.

Author:
anil.pacaci, anil.sinaci

Nested Class Summary
 
Nested classes/interfaces inherited from class org.apache.stanbol.commons.web.base.resource.BaseStanbolResource
org.apache.stanbol.commons.web.base.resource.BaseStanbolResource.MenuItem
 
Field Summary
 
Fields inherited from class org.apache.stanbol.commons.web.base.resource.BaseStanbolResource
LINK_RESOURCES, NAVIGATION_LINKS, ROOT_URL, SCRIPT_RESOURCES, servletContext, STATIC_RESOURCES_ROOT_URL, SYSTEM_CONSOLE, uriInfo
 
Constructor Summary
SemanticIndexManagerResource(javax.servlet.ServletContext context)
           
 
Method Summary
 javax.ws.rs.core.Response deleteProgram(String programName, javax.ws.rs.core.HttpHeaders headers)
          HTTP DELETE method to delete an LDPath program.
 javax.ws.rs.core.Response deleteProgramPath(String programName, javax.ws.rs.core.HttpHeaders headers)
          HTTP DELETE method to delete an LDPath program.
 List<org.apache.stanbol.contenthub.servicesapi.ldpath.LDProgram> getLdPrograms()
           
 javax.ws.rs.core.Response getProgramByName(String programName, javax.ws.rs.core.HttpHeaders headers)
          HTTP GET method to retrieve an LDPath program, given its name.
 javax.ws.rs.core.Response getProgramByNamePath(String programName, javax.ws.rs.core.HttpHeaders headers)
          HTTP GET method to retrieve an LDPath program, given its name.
 javax.ws.rs.core.Response handleCorsPreflight(javax.ws.rs.core.HttpHeaders headers)
           
 javax.ws.rs.core.Response handleCorsPreflightDeleteProgram(javax.ws.rs.core.HttpHeaders headers)
           
 javax.ws.rs.core.Response handleCorsPreflightExists(javax.ws.rs.core.HttpHeaders headers)
           
 javax.ws.rs.core.Response handleCorsPreflightExistsPath(javax.ws.rs.core.HttpHeaders headers)
           
 javax.ws.rs.core.Response handleCorsPreflightProgram(javax.ws.rs.core.HttpHeaders headers)
           
 javax.ws.rs.core.Response isManagedProgram(String programName, javax.ws.rs.core.HttpHeaders headers)
          HTTP GET method to check whether an LDPath program exists in Contenthub or not.
 javax.ws.rs.core.Response isManagedProgramPath(String programName, javax.ws.rs.core.HttpHeaders headers)
          HTTP GET method to check whether an LDPath program exists in Contenthub or not.
 javax.ws.rs.core.Response retrieveAllPrograms(javax.ws.rs.core.HttpHeaders headers)
          HTTP GET method which returns all LDPath programs residing in Contenthub.
 javax.ws.rs.core.Response submitProgram(String programName, String program, javax.ws.rs.core.HttpHeaders headers)
          HTTP POST method which takes an LDPath program into and creates a Solr index of which configuration is adjusted according to the given LDPath program.
 
Methods inherited from class org.apache.stanbol.commons.web.base.resource.BaseStanbolResource
getConsoleBaseUri, getMainMenuItems, getNavigationLinks, getPublicBaseUri, getRegisteredLinkResources, getRegisteredScriptResources, getRequestUri, getRootUrl, getStaticRootUrl
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SemanticIndexManagerResource

public SemanticIndexManagerResource(@Context
                                    javax.servlet.ServletContext context)
Method Detail

handleCorsPreflight

public javax.ws.rs.core.Response handleCorsPreflight(@Context
                                                     javax.ws.rs.core.HttpHeaders headers)

handleCorsPreflightProgram

public javax.ws.rs.core.Response handleCorsPreflightProgram(@Context
                                                            javax.ws.rs.core.HttpHeaders headers)

handleCorsPreflightDeleteProgram

public javax.ws.rs.core.Response handleCorsPreflightDeleteProgram(@Context
                                                                  javax.ws.rs.core.HttpHeaders headers)

handleCorsPreflightExists

public javax.ws.rs.core.Response handleCorsPreflightExists(@Context
                                                           javax.ws.rs.core.HttpHeaders headers)

handleCorsPreflightExistsPath

public javax.ws.rs.core.Response handleCorsPreflightExistsPath(@Context
                                                               javax.ws.rs.core.HttpHeaders headers)

retrieveAllPrograms

public javax.ws.rs.core.Response retrieveAllPrograms(@Context
                                                     javax.ws.rs.core.HttpHeaders headers)
HTTP GET method which returns all LDPath programs residing in Contenthub. LDPath programs are uniquely identified by their names. Returning JSON string presents each LDPath program in string format aligned with its name.

Parameters:
headers - HTTP headers
Returns:
JSON string of name:program pairs.

submitProgram

public javax.ws.rs.core.Response submitProgram(String programName,
                                               String program,
                                               @Context
                                               javax.ws.rs.core.HttpHeaders headers)
                                        throws org.apache.stanbol.contenthub.servicesapi.ldpath.LDPathException,
                                               URISyntaxException
HTTP POST method which takes an LDPath program into and creates a Solr index of which configuration is adjusted according to the given LDPath program.

Parameters:
programName - Unique name to identify the LDPath program
program - The LDPath program.
headers - HTTP Headers
Returns:
HTTP CREATED(201) or BAD REQUEST(400)
Throws:
org.apache.stanbol.contenthub.servicesapi.ldpath.LDPathException
URISyntaxException

getProgramByName

public javax.ws.rs.core.Response getProgramByName(String programName,
                                                  @Context
                                                  javax.ws.rs.core.HttpHeaders headers)
HTTP GET method to retrieve an LDPath program, given its name.

Parameters:
programName - The name of the LDPath program to be retrieved.
headers - HTTP headers
Returns:
LDPath program in String format or HTTP BAD_REQUEST(400) or HTTP NOT FOUND(404)

getProgramByNamePath

public javax.ws.rs.core.Response getProgramByNamePath(String programName,
                                                      @Context
                                                      javax.ws.rs.core.HttpHeaders headers)
HTTP GET method to retrieve an LDPath program, given its name.

Parameters:
programName - The name of the LDPath program to be retrieved.
headers - HTTP headers
Returns:
LDPath program in String format or HTTP BAD_REQUEST(400) or HTTP NOT FOUND(404)

deleteProgram

public javax.ws.rs.core.Response deleteProgram(String programName,
                                               @Context
                                               javax.ws.rs.core.HttpHeaders headers)
HTTP DELETE method to delete an LDPath program.

Parameters:
programName - The name of the LDPath program.
headers - HTTP headers
Returns:
HTTP OK(200), HTTP BAD_REQUEST(400) or HTTP NOT FOUND(403)

deleteProgramPath

public javax.ws.rs.core.Response deleteProgramPath(String programName,
                                                   @Context
                                                   javax.ws.rs.core.HttpHeaders headers)
HTTP DELETE method to delete an LDPath program.

Parameters:
programName - The name of the LDPath program.
headers - HTTP headers
Returns:
HTTP OK(200), HTTP BAD_REQUEST(400) or HTTP NOT FOUND(403)

isManagedProgram

public javax.ws.rs.core.Response isManagedProgram(String programName,
                                                  @Context
                                                  javax.ws.rs.core.HttpHeaders headers)
HTTP GET method to check whether an LDPath program exists in Contenthub or not.

Parameters:
programName - The name of the LDPath program.
headers - HTTP headers
Returns:
HTTP OK(200), HTTP BAD REQUEST(400) or HTTP NOT FOUND(404)

isManagedProgramPath

public javax.ws.rs.core.Response isManagedProgramPath(String programName,
                                                      @Context
                                                      javax.ws.rs.core.HttpHeaders headers)
HTTP GET method to check whether an LDPath program exists in Contenthub or not.

Parameters:
programName - The name of the LDPath program.
headers - HTTP headers
Returns:
HTTP OK(200), HTTP BAD REQUEST(400) or HTTP NOT FOUND(404)

getLdPrograms

public List<org.apache.stanbol.contenthub.servicesapi.ldpath.LDProgram> getLdPrograms()
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2011-2013 The Apache Software Foundation. All Rights Reserved.