Package de.hybris.platform.jalo.media

Class MediaFolder

java.lang.Object
de.hybris.platform.util.BridgeAbstraction
de.hybris.platform.jalo.Item
de.hybris.platform.jalo.ExtensibleItem
de.hybris.platform.jalo.c2l.LocalizableItem
de.hybris.platform.jalo.GenericItem
de.hybris.platform.jalo.media.GeneratedMediaFolder
de.hybris.platform.jalo.media.MediaFolder
All Implemented Interfaces:
Serializable, Comparable
public class MediaFolder extends GeneratedMediaFolder
Represents a folder where medias will be store it data files. Such a folder item is represented by a unique qualifier for easier management and a physical path relative to the media webroot. Is a folder set at a media, the media will store it data files at the media webroot concatenated with the relative path of the folder item. Using different folders for medias you get a way for structuring the medias, you can avoid big amounts of data files within one folder (file system problematic) and you can restrict access to specific folders from outside. For example you can restrict the access to data files produced by ImpExMedias, which are mostly security sensitive.
Since:
3.1-u4
See Also:

  • Constructor Details

    • MediaFolder

      public MediaFolder()

  • Method Details

    • createItem

      protected Item createItem(SessionContext ctx, ComposedType type, Item.ItemAttributeMap allAttributes) throws JaloBusinessException
      Description copied from class: Item
      Has to be implemented for each concrete subtype of item. This method is responsible for creating a new item instance ( by calling managers, ejb homes, etc. ) during ComposedType.newInstance(Map).

      In case this method uses any of the attribute values during creation it is required to override Item.getNonInitialAttributes(SessionContext, ItemAttributeMap) too.
      Sn example: 

      
 public static final String MY_ATTRIBUTE = "someAttribute"; ... protected Item createItem(SessionContext
 ctx, ComposedType type, Map allAttributes ) throws JaloBusinessException { MyManager man = ... return
 man.createMyItem( (String)allAttributes.get(MY_ATTRIBUTE) );
 // here MY_ATTRIBUTE is used for creation, so it must not be set again } protected Map getNonInitialAttributes(
 SessionContext ctx, Map allAttributes ) { // let superclass remove its own initial attributes Map ret =
 super.getNonInitialAttributes( ctx, allAttributes );
 // remove MY_ATTRIBUTE from all attributes since if has already been set ret.remove(MY_ATTRIBUTE); return ret; }
      Overrides:
      createItem in class GenericItem
      Parameters:
      ctx - the current session context which this item is created within
      type - the actual item type ( since subtypes may not provide a own jalo class this may be different from the type which this method was implemented for )
      Returns:
      the new item instance
      Throws:
      JaloBusinessException - indicates an error during creation - any changes will be rollbacked

    • checkConsistency

      @Deprecated(since="ages", forRemoval=false) protected void checkConsistency(String newQualifier, PK myPK) throws ConsistencyCheckException
      Deprecated.
      since ages - - qualifier uniqueness is checked now before model save with MediaFolderValidator
      Throws:
      ConsistencyCheckException
      Since:
      3.1-u7

    • setQualifier

      @Deprecated(since="ages", forRemoval=false) public void setQualifier(SessionContext ctx, String value) throws JaloInvalidParameterException
      Deprecated.
      since ages - - qualifier uniqueness is checked now before model save with MediaFolderValidator
      Sets the qualifier of this folder with prior check of duplicates.
      Overrides:
      setQualifier in class GeneratedMediaFolder
      value - the qualifier - Identifies the folder by a qualifier
      Throws:
      JaloInvalidParameterException

    • setPath

      @Deprecated(since="ages", forRemoval=false) protected void setPath(SessionContext ctx, String value)
      Deprecated.
      since ages - it is not used anywhere
      Sets the path of this folder after normalization of it.
      Overrides:
      setPath in class GeneratedMediaFolder
      value - the path - The physical path of the folder relative the the media webroot

    • remove

      public void remove(SessionContext ctx) throws ConsistencyCheckException
      Description copied from class: Item
      Removes this item.

      This method is using the following attributes of the given SessionContext:

      CacheUsage   Language   StagingMethod
      n/a (this is a setter method)   no, language doesn't matter for removal   yes if called on a StageableItem, no otherwise


      Overrides:
      remove in class Item
      Parameters:
      ctx - A SessionContext object
      Throws:
      ConsistencyCheckException - if this item could not be removed for some reason

    • toString

      public String toString()
      Description copied from class: Item
      Returns the String representation of this item. This is by default the representation of the primary key of this item.
      Overrides:
      toString in class Item
      Returns:
      the String representation of this item.