ImageResizer  3.4.0
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events
Public Member Functions | Properties | List of all members
ImageResizer.Plugins.S3Reader.S3Reader Class Reference
Inheritance diagram for ImageResizer.Plugins.S3Reader.S3Reader:
Inheritance graph
[legend]
Collaboration diagram for ImageResizer.Plugins.S3Reader.S3Reader:
Collaboration graph
[legend]

Public Member Functions

 S3Reader (NameValueCollection args)
 
Configuration.Xml.Node RedactFrom (Node resizer)
 
IPlugin Install (Configuration.Config c)
 
bool Uninstall (Configuration.Config c)
 This plugin can only be removed if it was installed as an IVirtualImageProvider (vpp="false") More...
 
- Public Member Functions inherited from ImageResizer.Plugins.IPlugin
IPlugin Install (Config c)
 Installs the plugin in the specified Config instance. The plugin must handle all the work of loading settings, registering the plugin etc. More...
 
bool Uninstall (Config c)
 Uninstalls the plugin. Should reverse all changes made during Install More...
 

Properties

AmazonS3Client S3Client [get, set]
 Configure AWS access keys More...
 
bool RequireImageExtension [get, set]
 (default true) When false, all URLs inside the PathPrefix folder will be assumed to be images, and will be handled by this plugin. You should still use image extensions, otherwise we don't know what content type to send with the response, and browsers will choke. It's also the cleanest way to tell the image resizer what kind of file type you'd like back when you request resizing. This setting is designed to support non-image file serving from the DB. It will also cause conflicts if PathPrefix overlaps with a folder name used for something else. More...
 
bool UntrustedData [get, set]
 (default: false) When true, all requests will be re-encoded before being served to the client. Invalid or malicious images will fail with an error if they cannot be read as images. This should prevent malicious files from being served to the client. More...
 
bool CacheUnmodifiedFiles [get, set]
 (default true). When true, files and unmodified images (i.e, no querystring) will be cached to disk (if they are requested that way) instead of only caching requests for resized images. DiskCache plugin must be installed for this to have any effect. More...
 

Detailed Description

Definition at line 17 of file S3Reader.cs.

Member Function Documentation

bool ImageResizer.Plugins.S3Reader.S3Reader.Uninstall ( Configuration.Config  c)
inline

This plugin can only be removed if it was installed as an IVirtualImageProvider (vpp="false")

Parameters
c
Returns

Definition at line 187 of file S3Reader.cs.

187  {
188  if (!asVpp) {
189  c.Plugins.VirtualProviderPlugins.Remove(vpp);
190  return true;
191  }else
192  return false;
193  }

Property Documentation

bool ImageResizer.Plugins.S3Reader.S3Reader.CacheUnmodifiedFiles
getset

(default true). When true, files and unmodified images (i.e, no querystring) will be cached to disk (if they are requested that way) instead of only caching requests for resized images. DiskCache plugin must be installed for this to have any effect.

Definition at line 98 of file S3Reader.cs.

bool ImageResizer.Plugins.S3Reader.S3Reader.RequireImageExtension
getset

(default true) When false, all URLs inside the PathPrefix folder will be assumed to be images, and will be handled by this plugin. You should still use image extensions, otherwise we don't know what content type to send with the response, and browsers will choke. It's also the cleanest way to tell the image resizer what kind of file type you'd like back when you request resizing. This setting is designed to support non-image file serving from the DB. It will also cause conflicts if PathPrefix overlaps with a folder name used for something else.

Definition at line 78 of file S3Reader.cs.

AmazonS3Client ImageResizer.Plugins.S3Reader.S3Reader.S3Client
getset

Configure AWS access keys

Definition at line 66 of file S3Reader.cs.

bool ImageResizer.Plugins.S3Reader.S3Reader.UntrustedData
getset

(default: false) When true, all requests will be re-encoded before being served to the client. Invalid or malicious images will fail with an error if they cannot be read as images. This should prevent malicious files from being served to the client.

Definition at line 88 of file S3Reader.cs.


The documentation for this class was generated from the following file: