ImageUploadController (Vitro API 1.12.1 API)

java.lang.Object
- javax.servlet.GenericServlet
- - javax.servlet.http.HttpServlet
  - - edu.cornell.mannlib.vitro.webapp.controller.VitroHttpServlet
    - - edu.cornell.mannlib.vitro.webapp.controller.freemarker.FreemarkerHttpServlet
      - edu.cornell.mannlib.vitro.webapp.controller.freemarker.ImageUploadController

All Implemented Interfaces:

MultipartRequestWrapper.ParsingStrategy, Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig
```
@WebServlet(name="ImageUploadController",
            urlPatterns="/uploadImages")
public class ImageUploadController
extends FreemarkerHttpServlet
```
Handle adding, replacing or deleting the main image on an Individual.

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class edu.cornell.mannlib.vitro.webapp.controller.freemarker.FreemarkerHttpServlet
  FreemarkerHttpServlet.Template
- Nested classes/interfaces inherited from class edu.cornell.mannlib.vitro.webapp.controller.VitroHttpServlet
  VitroHttpServlet.PickListSorter

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ACTION_DELETE` A request to delete the file and return to the referring page.
`static String`	`ACTION_DELETE_EDIT` A request to delete the file and return to the "new image" screen.
`static String`	`ACTION_SAVE` Here is the cropping info; we're ready to save the image.
`static String`	`ACTION_UPLOAD` Here is the main image file.
`static String`	`BODY_CANCEL_URL`
`static String`	`BODY_DELETE_URL`
`static String`	`BODY_ENTITY_NAME`
`static String`	`BODY_ERROR_MESSAGE`
`static String`	`BODY_FORM_ACTION`
`static String`	`BODY_MAIN_IMAGE_HEIGHT`
`static String`	`BODY_MAIN_IMAGE_URL`
`static String`	`BODY_MAIN_IMAGE_WIDTH`
`static String`	`BODY_MAX_FILE_SIZE`
`static String`	`BODY_THUMBNAIL_HEIGHT`
`static String`	`BODY_THUMBNAIL_URL`
`static String`	`BODY_THUMBNAIL_WIDTH`
`static String`	`BODY_TITLE`
`static int`	`MAXIMUM_FILE_SIZE` Limit file size to 6 megabytes.
`static String`	`PARAMETER_ACTION` The form field that tells what we are doing: uploading? deleting?
`static String`	`PARAMETER_ENTITY_URI` The form field that identifies the Individual.
`static String`	`PARAMETER_UPLOADED_FILE` The form field of the uploaded file; use as a key to the FileItem map.
`static String`	`TEMPLATE_CROP`
`static String`	`TEMPLATE_ERROR`
`static String`	`TEMPLATE_NEW`
`static String`	`TEMPLATE_REPLACE`
`static int`	`THUMBNAIL_HEIGHT` Generated thumbnails will be this big.
`static int`	`THUMBNAIL_WIDTH`

Fields inherited from class edu.cornell.mannlib.vitro.webapp.controller.freemarker.FreemarkerHttpServlet
BODY_TEMPLATE_TYPE, PAGE_TEMPLATE_TYPE

Fields inherited from class edu.cornell.mannlib.vitro.webapp.controller.VitroHttpServlet
HTML_MIMETYPE, JSON_LD_MIMETYPE, JSON_MIMETYPE, N3_MIMETYPE, publicDateFormat, RDFXML_MIMETYPE, TTL_MIMETYPE, XHTML_MIMETYPE

Constructor Summary

Constructors
Constructor and Description

ImageUploadController()

Constructors
Constructor and Description
`ImageUploadController()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`init()` When initialized, get a reference to the File Storage system.
`long`	`maximumMultipartFileSize()` How large an image file will we accept?
`protected ResponseValues`	`processRequest(VitroRequest vreq)` Handle the different actions.
`protected AuthorizationRequest`	`requiredActions(VitroRequest vreq)` The required action depends on what we are trying to do.
`boolean`	`stashFileSizeException()` What will we do if there is a problem parsing the request?

Methods inherited from class edu.cornell.mannlib.vitro.webapp.controller.freemarker.FreemarkerHttpServlet
doException, doForward, doGet, doPost, doRdf, doRedirect, doResponse, doTemplate, getBeansWrapper, getDisplayModelMenu, getFreemarkerComponentsForJsp, getPageTemplateName, getPageTemplateValues, getThemeDir, getTitle, handleException, processTemplate, processTemplateToString, wrap, wrap, write, writePage, writeTemplate, writeTemplate

Methods inherited from class edu.cornell.mannlib.vitro.webapp.controller.VitroHttpServlet
dumpRequestParameters, isAuthorizedToDisplayPage, redirectToInsufficientAuthorizationPage, redirectToLoginPage, redirectUnauthorizedRequest, service, sortForPickList

Methods inherited from class javax.servlet.http.HttpServlet
doDelete, doHead, doOptions, 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
  - MAXIMUM_FILE_SIZE
```
public static final int MAXIMUM_FILE_SIZE
```
    Limit file size to 6 megabytes.
    
    See Also:
    
    Constant Field Values
  - THUMBNAIL_HEIGHT
```
public static final int THUMBNAIL_HEIGHT
```
    Generated thumbnails will be this big.
    
    See Also:
    
    Constant Field Values
  - THUMBNAIL_WIDTH
```
public static final int THUMBNAIL_WIDTH
```
    See Also:
    
    Constant Field Values
  - PARAMETER_ACTION
```
public static final String PARAMETER_ACTION
```
    The form field that tells what we are doing: uploading? deleting?
    
    See Also:
    
    Constant Field Values
  - PARAMETER_ENTITY_URI
```
public static final String PARAMETER_ENTITY_URI
```
    The form field that identifies the Individual.
    
    See Also:
    
    Constant Field Values
  - PARAMETER_UPLOADED_FILE
```
public static final String PARAMETER_UPLOADED_FILE
```
    The form field of the uploaded file; use as a key to the FileItem map.
    
    See Also:
    
    Constant Field Values
  - ACTION_UPLOAD
```
public static final String ACTION_UPLOAD
```
    Here is the main image file. Hold on to it.
    
    See Also:
    
    Constant Field Values
  - ACTION_SAVE
```
public static final String ACTION_SAVE
```
    Here is the cropping info; we're ready to save the image.
    
    See Also:
    
    Constant Field Values
  - ACTION_DELETE
```
public static final String ACTION_DELETE
```
    A request to delete the file and return to the referring page.
    
    See Also:
    
    Constant Field Values
  - ACTION_DELETE_EDIT
```
public static final String ACTION_DELETE_EDIT
```
    A request to delete the file and return to the "new image" screen.
    
    See Also:
    
    Constant Field Values
  - BODY_TITLE
```
public static final String BODY_TITLE
```
    See Also:
    
    Constant Field Values
  - BODY_ENTITY_NAME
```
public static final String BODY_ENTITY_NAME
```
    See Also:
    
    Constant Field Values
  - BODY_MAIN_IMAGE_URL
```
public static final String BODY_MAIN_IMAGE_URL
```
    See Also:
    
    Constant Field Values
  - BODY_MAIN_IMAGE_HEIGHT
```
public static final String BODY_MAIN_IMAGE_HEIGHT
```
    See Also:
    
    Constant Field Values
  - BODY_MAIN_IMAGE_WIDTH
```
public static final String BODY_MAIN_IMAGE_WIDTH
```
    See Also:
    
    Constant Field Values
  - BODY_THUMBNAIL_URL
```
public static final String BODY_THUMBNAIL_URL
```
    See Also:
    
    Constant Field Values
  - BODY_CANCEL_URL
```
public static final String BODY_CANCEL_URL
```
    See Also:
    
    Constant Field Values
  - BODY_DELETE_URL
```
public static final String BODY_DELETE_URL
```
    See Also:
    
    Constant Field Values
  - BODY_FORM_ACTION
```
public static final String BODY_FORM_ACTION
```
    See Also:
    
    Constant Field Values
  - BODY_ERROR_MESSAGE
```
public static final String BODY_ERROR_MESSAGE
```
    See Also:
    
    Constant Field Values
  - BODY_MAX_FILE_SIZE
```
public static final String BODY_MAX_FILE_SIZE
```
    See Also:
    
    Constant Field Values
  - BODY_THUMBNAIL_WIDTH
```
public static final String BODY_THUMBNAIL_WIDTH
```
    See Also:
    
    Constant Field Values
  - BODY_THUMBNAIL_HEIGHT
```
public static final String BODY_THUMBNAIL_HEIGHT
```
    See Also:
    
    Constant Field Values
  - TEMPLATE_NEW
```
public static final String TEMPLATE_NEW
```
    See Also:
    
    Constant Field Values
  - TEMPLATE_REPLACE
```
public static final String TEMPLATE_REPLACE
```
    See Also:
    
    Constant Field Values
  - TEMPLATE_CROP
```
public static final String TEMPLATE_CROP
```
    See Also:
    
    Constant Field Values
  - TEMPLATE_ERROR
```
public static final String TEMPLATE_ERROR
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ImageUploadController
```
public ImageUploadController()
```
- Method Detail
  - init
```
public void init()
          throws javax.servlet.ServletException
```
    When initialized, get a reference to the File Storage system. Without that, we can do nothing.
    
    Overrides:
    
    init in class javax.servlet.GenericServlet
    
    Throws:
    
    javax.servlet.ServletException
  - maximumMultipartFileSize
```
public long maximumMultipartFileSize()
```
    How large an image file will we accept?
    
    Specified by:
    
    maximumMultipartFileSize in interface MultipartRequestWrapper.ParsingStrategy
    
    Overrides:
    
    maximumMultipartFileSize in class VitroHttpServlet
  - stashFileSizeException
```
public boolean stashFileSizeException()
```
    What will we do if there is a problem parsing the request?
    
    Specified by:
    
    stashFileSizeException in interface MultipartRequestWrapper.ParsingStrategy
    
    Overrides:
    
    stashFileSizeException in class VitroHttpServlet
  - requiredActions
```
protected AuthorizationRequest requiredActions(VitroRequest vreq)
```
    The required action depends on what we are trying to do.
    
    Overrides:
    
    requiredActions in class FreemarkerHttpServlet
  - processRequest
```
protected ResponseValues processRequest(VitroRequest vreq)
```
    Handle the different actions. If not specified, the default action is to show the intro screen.
    
    Overrides:
    
    processRequest in class FreemarkerHttpServlet

Class ImageUploadController

Nested Class Summary

Nested classes/interfaces inherited from class edu.cornell.mannlib.vitro.webapp.controller.freemarker.FreemarkerHttpServlet

Nested classes/interfaces inherited from class edu.cornell.mannlib.vitro.webapp.controller.VitroHttpServlet

Field Summary

Fields inherited from class edu.cornell.mannlib.vitro.webapp.controller.freemarker.FreemarkerHttpServlet

Fields inherited from class edu.cornell.mannlib.vitro.webapp.controller.VitroHttpServlet

Constructor Summary

Method Summary

Methods inherited from class edu.cornell.mannlib.vitro.webapp.controller.freemarker.FreemarkerHttpServlet

Methods inherited from class edu.cornell.mannlib.vitro.webapp.controller.VitroHttpServlet

Methods inherited from class javax.servlet.http.HttpServlet

Methods inherited from class javax.servlet.GenericServlet

Methods inherited from class java.lang.Object

Field Detail

MAXIMUM_FILE_SIZE

THUMBNAIL_HEIGHT

THUMBNAIL_WIDTH

PARAMETER_ACTION

PARAMETER_ENTITY_URI

PARAMETER_UPLOADED_FILE

ACTION_UPLOAD

ACTION_SAVE

ACTION_DELETE

ACTION_DELETE_EDIT

BODY_TITLE

BODY_ENTITY_NAME

BODY_MAIN_IMAGE_URL

BODY_MAIN_IMAGE_HEIGHT

BODY_MAIN_IMAGE_WIDTH

BODY_THUMBNAIL_URL

BODY_CANCEL_URL

BODY_DELETE_URL

BODY_FORM_ACTION

BODY_ERROR_MESSAGE

BODY_MAX_FILE_SIZE

BODY_THUMBNAIL_WIDTH

BODY_THUMBNAIL_HEIGHT

TEMPLATE_NEW

TEMPLATE_REPLACE

TEMPLATE_CROP

TEMPLATE_ERROR

Constructor Detail

ImageUploadController

Method Detail

init

maximumMultipartFileSize

stashFileSizeException

requiredActions

processRequest