- Getting Started
- Browser Support
- Languages Support
- Shortcuts
- Activation
- Examples
- Customize the Editor
- Use-cases
- Plugins
- APIs
- Development Frameworks
- Server Integrations
- Server SDKs
- Migration Guides
- Changelog
- Tutorials
Java SDK Image Reference
Upload (request, fileRoute, options)
Returns: Map<Object, Object>
Method used to upload an image to the specified location on disk.
Parameters:
-
request
All the HTTP specific information for the HTTP request.
Type: HttpServletRequest
-
fileRoute
The server route where the image will be uploaded. This route must be public.
Type: String
-
options
This parameter is optional. It is used to pass custom options for the image upload.
Short example:
ImageOptions options = new ImageOptions(); options.setResize(width, height, keepAspectRatio);
Type: ImageOptions
options parameter:
-
fieldname
Tag name that points to the file. Use getter/setter to access it.
option.setFieldname('my-custom-fieldname'); option.getFieldname();
Type: String Default: "file"
-
validation
Specified the allowed image extensions and mimetypes. Use getter/setter to access it.
options.setValidation(new ImageValidation()); options.setValidation(new ImageValidation(new String[] { "gif", "jpeg" }, new String[] { "image/gif", "image/jpeg" })); options.setValidation(new ImageValidation(new CustomValidation() { @Override public boolean validate(String filePath, String mimeType) { } })); options.getValidation();
Type: ImageValidation Default: /// Allowed image validation default extensions. public static final String[] allowedImageExtsDefault = new String[] { "gif", "jpeg", "jpg", "png", "svg", "blob" }; /// Allowed image validation default mimetypes. public static final String[] allowedImageMimeTypesDefault = new String[] { "image/gif", "image/jpeg", "image/pjpeg", "image/x-png", "image/png", "image/svg+xml" };
-
resizeOptions
Used to resize the image to a fixed size. Use getter/setter to access it.
ResizeOptions resizeOptions = options.new ResizeOptions(); resizeOptions.setNewWidth(300); resizeOptions.setNewHeight(400); resizeOptions.setKeepAspectRatio(true); options.setResizeOptions(resizeOptions); options.setResize(300, 400, true); options.getResizeOptions();
Type: ImageOptions.ResizeOptions Default: NULL
Response
If the upload is successful, the method returns an object with the absolute path to the uploaded image. If an error occurs, the method throws an exception.
Map<Object, Object> responseData;
try {
responseData = Image.upload(request, fileRoute, options);
} catch (Exception e) {
e.printStackTrace();
responseData = new HashMap
Delete (request, filePath)
Method used to delete an image from disk. Throws an exception if an error occurs.
Parameters:
-
request
All the HTTP specific information for the HTTP request.
Type: HttpServletRequest
-
filePath
The server image path.
Type: String
List (request, folderPath, thumbPath)
Returns: ArrayList<Object>
Method used to list all images from disk.
Parameters:
-
request
All the HTTP specific information for the HTTP request.
Type: HttpServletRequest
-
folderPath
The path of the folder from where the images are being loaded.
Type: String
-
thumbPath
This parameter is optional. The path of the folder from where the image thumbs are being loaded.
Type: String
Response
If the load is completed successfully, the method returns a list with objects containing the image url, thumb and name. If an error occurs, the method throws an exception.
ArrayList<Object> responseData;
try {
responseData = Image.list(request, fileRoute);
} catch (Exception e) {
e.printStackTrace();
response.sendError(HttpServletResponse.SC_INTERNAL_SERVER_ERROR);
return;
}
String jsonResponseData = new Gson().toJson(responseData);
response.setContentType("application/json");
response.setCharacterEncoding("UTF-8");
response.getWriter().write(jsonResponseData);
Do you think we can improve this article? Let us know.