|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opencms.file.types.A_CmsResourceType
org.opencms.file.types.CmsResourceTypeImage
Resource type descriptor for the type "image".
Nested Class Summary | |
protected class |
CmsResourceTypeImage.CmsImageAdjuster
A data container for image size and scale operations. |
Field Summary | |
static org.apache.commons.logging.Log |
LOG
The log object for this class. |
static java.lang.String |
PROPERTY_VALUE_UNLIMITED
The value for the CmsPropertyDefinition.PROPERTY_IMAGE_SIZE property if resources in
a folder should never be downscaled. |
Fields inherited from class org.opencms.file.types.A_CmsResourceType |
m_addititionalModuleResourceType, m_className, m_copyResources, m_defaultProperties, m_frozen, m_mappings, m_typeId, m_typeName, MACRO_RESOURCE_FOLDER_PATH, MACRO_RESOURCE_NAME, MACRO_RESOURCE_PARENT_PATH, MACRO_RESOURCE_ROOT_PATH, MACRO_RESOURCE_SITE_PATH |
Fields inherited from interface org.opencms.file.types.I_CmsResourceType |
ADD_MAPPING_METHOD, ADD_RESOURCE_TYPE_METHOD, CONFIGURATION_PROPERTY_CREATE, CONFIGURATION_RESOURCE_TYPE_ID, CONFIGURATION_RESOURCE_TYPE_NAME, PROPERTY_ON_RESOURCE, PROPERTY_ON_STRUCTURE |
Fields inherited from interface org.opencms.configuration.I_CmsConfigurationParameterHandler |
ADD_PARAMETER_METHOD, INIT_CONFIGURATION_METHOD |
Constructor Summary | |
CmsResourceTypeImage()
Default constructor, used to initialize member variables. |
Method Summary | |
CmsResource |
createResource(CmsObject cms,
CmsSecurityManager securityManager,
java.lang.String resourcename,
byte[] content,
java.util.List properties)
Creates a new resource of the given resource type with the provided content and properties. |
static CmsImageScaler |
getDownScaler(CmsObject cms,
java.lang.String rootPath)
Returns the image downscaler to use when writing an image resource to the given root path. |
int |
getLoaderId()
Returns the loader type id of this resource type. |
static int |
getStaticTypeId()
Returns the static type id of this (default) resource type. |
static java.lang.String |
getStaticTypeName()
Returns the static type name of this (default) resource type. |
CmsResource |
importResource(CmsObject cms,
CmsSecurityManager securityManager,
java.lang.String resourcename,
CmsResource resource,
byte[] content,
java.util.List properties)
Imports a resource to the OpenCms VFS. |
void |
initConfiguration(java.lang.String name,
java.lang.String id,
java.lang.String className)
Special version of the configuration initialization used with resource types to set resource type, id and class name, required for the XML configuration. |
void |
replaceResource(CmsObject cms,
CmsSecurityManager securityManager,
CmsResource resource,
int type,
byte[] content,
java.util.List properties)
Replaces the content, type and properties of a resource. |
CmsFile |
writeFile(CmsObject cms,
CmsSecurityManager securityManager,
CmsFile resource)
Writes a resource, including it's content. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final org.apache.commons.logging.Log LOG
public static final java.lang.String PROPERTY_VALUE_UNLIMITED
CmsPropertyDefinition.PROPERTY_IMAGE_SIZE
property if resources in
a folder should never be downscaled.
Constructor Detail |
public CmsResourceTypeImage()
Method Detail |
public static CmsImageScaler getDownScaler(CmsObject cms, java.lang.String rootPath)
If null
is returned, image downscaling must not be used for the resource with the given path.
This may be the case if image downscaling is not configured at all, or if image downscaling has been disabled
for the parent folder by setting the folders property CmsPropertyDefinition.PROPERTY_IMAGE_SIZE
to the value PROPERTY_VALUE_UNLIMITED
.
cms
- the current OpenCms user contextrootPath
- the root path of the resource to write
null
if no downscaling is required for the resourcepublic static int getStaticTypeId()
public static java.lang.String getStaticTypeName()
public CmsResource createResource(CmsObject cms, CmsSecurityManager securityManager, java.lang.String resourcename, byte[] content, java.util.List properties) throws CmsException
I_CmsResourceType
createResource
in interface I_CmsResourceType
createResource
in class A_CmsResourceType
CmsException
I_CmsResourceType.createResource(org.opencms.file.CmsObject, org.opencms.db.CmsSecurityManager, java.lang.String, byte[], java.util.List)
public int getLoaderId()
I_CmsResourceType
getLoaderId
in interface I_CmsResourceType
getLoaderId
in class A_CmsResourceType
I_CmsResourceType.getLoaderId()
public CmsResource importResource(CmsObject cms, CmsSecurityManager securityManager, java.lang.String resourcename, CmsResource resource, byte[] content, java.util.List properties) throws CmsException
I_CmsResourceType
If a resource already exists in the VFS (i.e. has the same name and same id) it is replaced by the imported resource.
If a resource with the same name but a different id exists, the imported resource is (usually) moved to the "lost and found" folder.
importResource
in interface I_CmsResourceType
importResource
in class A_CmsResourceType
CmsException
I_CmsResourceType.importResource(org.opencms.file.CmsObject, org.opencms.db.CmsSecurityManager, java.lang.String, org.opencms.file.CmsResource, byte[], java.util.List)
public void initConfiguration(java.lang.String name, java.lang.String id, java.lang.String className) throws CmsConfigurationException
I_CmsResourceType
Please note: Many resource types defined in the core have in fact a fixed resource type and a fixed id. Configurable name and id is used only for certain types.
The provided named class must implement this interface (
).
Usually the provided class name should be the class name of the resource type instance,
but this may be different in special cases or configuration errors.
For example, if a module is imported that contains it's own resource type class files,
the included class file are usually not be available until the server is restarted.
If the named class given in the XML configuration (or module manifest.xml) is not available,
or not implementing I_CmsResourceType
,
then I_CmsResourceType
is used for the resource type instance.CmsResourceTypeUnknown
initConfiguration
in interface I_CmsResourceType
initConfiguration
in class A_CmsResourceType
CmsConfigurationException
A_CmsResourceType.initConfiguration(java.lang.String, java.lang.String, String)
public void replaceResource(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, int type, byte[] content, java.util.List properties) throws CmsException
I_CmsResourceType
replaceResource
in interface I_CmsResourceType
replaceResource
in class A_CmsResourceType
CmsException
I_CmsResourceType.replaceResource(org.opencms.file.CmsObject, org.opencms.db.CmsSecurityManager, org.opencms.file.CmsResource, int, byte[], java.util.List)
public CmsFile writeFile(CmsObject cms, CmsSecurityManager securityManager, CmsFile resource) throws CmsException, CmsVfsException, CmsSecurityException
I_CmsResourceType
Applies only to resources of type
that have a binary content attached.CmsFile
writeFile
in interface I_CmsResourceType
writeFile
in class A_CmsResourceType
CmsException
CmsVfsException
CmsSecurityException
I_CmsResourceType.writeFile(org.opencms.file.CmsObject, org.opencms.db.CmsSecurityManager, org.opencms.file.CmsFile)
|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |