net.myrrix.web.servlets

Class AbstractMyrrixServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

net.myrrix.web.servlets.AbstractMyrrixServlet

All Implemented Interfaces:

Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

Direct Known Subclasses:

AbstractAllIDsServlet, AbstractClusterServlet, BecauseServlet, EstimateForAnonymousServlet, EstimateServlet, IngestServlet, MostPopularItemsServlet, PreferenceServlet, ReadyServlet, RecommendServlet, RecommendToAnonymousServlet, RecommendToManyServlet, RefreshServlet, SimilarityServlet, SimilarityToItemServlet, TagItemServlet, TagUserServlet

public abstract class AbstractMyrrixServlet
extends javax.servlet.http.HttpServlet

Superclass of HttpServlets used in the application. All API methods return the following HTTP statuses in certain situations:

• 302 Temporary Redirect if, in a distributed environment, another partition should handle the request
• 400 Bad Request if the arguments are invalid, like a non-numeric ID
• 401 Unauthorized if a username/password is required, but not supplied correctly in the request via HTTP DIGEST
• 405 Method Not Allowed if an incorrect HTTP method is used, like GET where POST is required
• 500 Internal Server Error if an unexpected server-side exception occurs
• 503 Service Unavailable if no model is yet available to serve requests

Author:

Sean Owen

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALL_PARTITIONS_REF_KEY
static String	LOCAL_INPUT_DIR_KEY
static String	PARTITION_KEY
static String	READ_ONLY_KEY
static String	RECOMMENDER_KEY
static String	RESCORER_PROVIDER_KEY
static String	TIMINGS_KEY

Constructor Summary

Constructors

Constructor and Description
AbstractMyrrixServlet()

Method Summary

Methods

Modifier and Type	Method and Description
protected static boolean	getConsiderKnownItems(javax.servlet.ServletRequest request)
protected static int	getHowMany(javax.servlet.ServletRequest request)
protected net.myrrix.common.MyrrixRecommender	getRecommender()
protected static String[]	getRescorerParams(javax.servlet.ServletRequest request)
protected RescorerProvider	getRescorerProvider()
ServletStats	getTiming()
protected Long	getUnnormalizedPartitionToServe(javax.servlet.http.HttpServletRequest request)
void	init(javax.servlet.ServletConfig config)
protected void	output(javax.servlet.http.HttpServletRequest request, javax.servlet.ServletResponse response, Iterable<org.apache.mahout.cf.taste.recommender.RecommendedItem> items) Outputs items in CSV or JSON format based on the HTTP Accept header.
protected void	service(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doGet, doHead, doOptions, doPost, doPut, doTrace, getLastModified, service

Methods inherited from class javax.servlet.GenericServlet

destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log

Methods inherited from class java.lang.Object

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

Field Detail

READ_ONLY_KEY

public static final String READ_ONLY_KEY

RECOMMENDER_KEY

public static final String RECOMMENDER_KEY

RESCORER_PROVIDER_KEY

public static final String RESCORER_PROVIDER_KEY

TIMINGS_KEY

public static final String TIMINGS_KEY

LOCAL_INPUT_DIR_KEY

public static final String LOCAL_INPUT_DIR_KEY

ALL_PARTITIONS_REF_KEY

public static final String ALL_PARTITIONS_REF_KEY

PARTITION_KEY

public static final String PARTITION_KEY

Constructor Detail

AbstractMyrrixServlet

public AbstractMyrrixServlet()

Method Detail

init

public void init(javax.servlet.ServletConfig config)
          throws javax.servlet.ServletException

Specified by:

init in interface javax.servlet.Servlet

Overrides:

init in class javax.servlet.GenericServlet

Throws:

javax.servlet.ServletException

service

protected final void service(javax.servlet.http.HttpServletRequest request,
           javax.servlet.http.HttpServletResponse response)
                      throws javax.servlet.ServletException,
                             IOException

Overrides:

service in class javax.servlet.http.HttpServlet

Throws:

javax.servlet.ServletException

IOException

getUnnormalizedPartitionToServe

protected Long getUnnormalizedPartitionToServe(javax.servlet.http.HttpServletRequest request)

Parameters:

request - request containing info that may determine which partition needs to serve it

Returns:

null if any partition may serve, or an integral value that should be used to determine the partiiton. This is usually an ID value, which will be possibly hashed and reduced modulo the number of partitions.

getRecommender

protected final net.myrrix.common.MyrrixRecommender getRecommender()

getRescorerProvider

protected final RescorerProvider getRescorerProvider()

getTiming

public final ServletStats getTiming()

getHowMany

protected static int getHowMany(javax.servlet.ServletRequest request)

getRescorerParams

protected static String[] getRescorerParams(javax.servlet.ServletRequest request)

getConsiderKnownItems

protected static boolean getConsiderKnownItems(javax.servlet.ServletRequest request)

output

protected final void output(javax.servlet.http.HttpServletRequest request,
          javax.servlet.ServletResponse response,
          Iterable<org.apache.mahout.cf.taste.recommender.RecommendedItem> items)
                     throws IOException

Outputs items in CSV or JSON format based on the HTTP Accept header.

CSV output contains one recommendation per line, and each line is of the form itemID, strength, like 325, 0.53. Strength is an opaque indicator of the relative quality of the recommendation.

JSON output is an array of arrays, with each sub-array containing an item ID and strength. Example: [[325, 0.53], [98, 0.499]].

Throws:

IOException