com.atlassian.jira.web.servlet
Class ViewUserAvatarServlet

java.lang.Object
  extended by javax.servlet.GenericServlet
      extended by javax.servlet.http.HttpServlet
          extended by com.atlassian.jira.web.servlet.AbstractAvatarServlet
              extended by com.atlassian.jira.web.servlet.ViewUserAvatarServlet
All Implemented Interfaces:
Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

public class ViewUserAvatarServlet
extends AbstractAvatarServlet

Serves avatar images for users.

Since:
v4.2
See Also:
Serialized Form

Constructor Summary
ViewUserAvatarServlet()
           
 
Method Summary
protected  void defaultDoGet(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String ownerId, Long avatarId, AvatarManager.ImageSize size)
          Template method that processes the GET request.
protected  String getOwnerId(javax.servlet.http.HttpServletRequest request)
           
protected  String getOwnerIdParamName()
          Slight hack to stay backwards compatible for project avatars via the 'pid' param.
protected  Long validateInput(String ownerId, Long avatarId, javax.servlet.http.HttpServletResponse response)
          Ensures the input is valid and if validation passes returns a valid avatarId to serve.
 
Methods inherited from class com.atlassian.jira.web.servlet.AbstractAvatarServlet
avatarOkForOwner, doGet, handleOutputStreamingException
 
Methods inherited from class javax.servlet.http.HttpServlet
doDelete, doHead, doOptions, doPost, doPut, doTrace, getLastModified, service, service
 
Methods inherited from class javax.servlet.GenericServlet
destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, init, log, log
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ViewUserAvatarServlet

public ViewUserAvatarServlet()
Method Detail

defaultDoGet

protected void defaultDoGet(javax.servlet.http.HttpServletRequest request,
                            javax.servlet.http.HttpServletResponse response,
                            String ownerId,
                            Long avatarId,
                            AvatarManager.ImageSize size)
                     throws IOException,
                            javax.servlet.ServletException
Description copied from class: AbstractAvatarServlet
Template method that processes the GET request. Subclasses may override this method to change the avatar serving logic.

Overrides:
defaultDoGet in class AbstractAvatarServlet
Throws:
IOException
javax.servlet.ServletException

validateInput

protected Long validateInput(String ownerId,
                             Long avatarId,
                             javax.servlet.http.HttpServletResponse response)
                      throws IOException
Description copied from class: AbstractAvatarServlet
Ensures the input is valid and if validation passes returns a valid avatarId to serve. If validation fails, this method should send errors on the response and return a null avatar id.

Specified by:
validateInput in class AbstractAvatarServlet
Parameters:
ownerId - The owner of the avatar
avatarId - The avatarId requested
response - The response to send
Returns:
The avatarId to serve to the user or null if validation fails
Throws:
IOException - If there's an error updating the response object

getOwnerId

protected String getOwnerId(javax.servlet.http.HttpServletRequest request)
Overrides:
getOwnerId in class AbstractAvatarServlet

getOwnerIdParamName

protected String getOwnerIdParamName()
Description copied from class: AbstractAvatarServlet
Slight hack to stay backwards compatible for project avatars via the 'pid' param. The project avatar servlet implementation can return pid here instead of ownerId.

Specified by:
getOwnerIdParamName in class AbstractAvatarServlet
Returns:
The parameter used to identify the owner in the request.


Copyright © 2002-2014 Atlassian. All Rights Reserved.