Package org.alfresco.transform.client.model.config

Class TransformServiceRegistryImpl

  • All Implemented Interfaces:
    TransformServiceRegistry, org.springframework.beans.factory.InitializingBean
    Direct Known Subclasses:
    LocalTransformServiceRegistry
    public abstract class TransformServiceRegistryImpl
extends java.lang.Object
implements TransformServiceRegistry, org.springframework.beans.factory.InitializingBean
    Used by clients to work out if a transformation is supported by the Transform Service.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected boolean enabled  

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      void afterPropertiesSet()  
      TransformServiceRegistryImpl.Data createData()  
      org.quartz.CronExpression getCronExpression()  
      TransformServiceRegistryImpl.Data getData()  
      protected boolean getFirstTime()  
      org.quartz.CronExpression getInitialAndOnErrorCronExpression()  
      protected abstract org.apache.commons.logging.Log getLog()  
      long getMaxSize​(java.lang.String sourceMimetype, java.lang.String targetMimetype, java.util.Map<java.lang.String,​java.lang.String> actualOptions, java.lang.String renditionName)
      Returns the maximun size (in bytes) of the source content that can be transformed.
      protected java.lang.String getTransformerName​(java.lang.String sourceMimetype, long sourceSizeInBytes, java.lang.String targetMimetype, java.util.Map<java.lang.String,​java.lang.String> actualOptions, java.lang.String renditionName)
      Works out the name of the transformer (might not map to an actual transformer) that will be used to transform content of a given source mimetype and size into a target mimetype given a list of actual transform option names and values (Strings) plus the data contained in the objects registered with this class.
      boolean isEnabled()  
      boolean isSupported​(java.lang.String sourceMimetype, long sourceSizeInBytes, java.lang.String targetMimetype, java.util.Map<java.lang.String,​java.lang.String> actualOptions, java.lang.String renditionName)
      Works out if the Transform Server should be able to transform content of a given source mimetype and size into a target mimetype given a list of actual transform option names and values (Strings) plus the data contained in the objects registered with this class.
      abstract boolean readConfig()  
      void register​(java.io.Reader reader, java.lang.String readFrom)  
      protected void register​(org.alfresco.transform.client.model.config.InlineTransformer transformer, java.lang.String baseUrl, java.lang.String readFrom)  
      void setCronExpression​(org.quartz.CronExpression cronExpression)  
      void setEnabled​(boolean enabled)  
      protected void setFirstTime​(boolean firstTime)  
      void setInitialAndOnErrorCronExpression​(org.quartz.CronExpression initialAndOnErrorCronExpression)  
      void setJsonObjectMapper​(com.fasterxml.jackson.databind.ObjectMapper jsonObjectMapper)  

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • enabled

        protected boolean enabled

    • Constructor Detail

      • TransformServiceRegistryImpl

        public TransformServiceRegistryImpl()

    • Method Detail

      • setJsonObjectMapper

        public void setJsonObjectMapper​(com.fasterxml.jackson.databind.ObjectMapper jsonObjectMapper)

      • getCronExpression

        public org.quartz.CronExpression getCronExpression()

      • setCronExpression

        public void setCronExpression​(org.quartz.CronExpression cronExpression)

      • getInitialAndOnErrorCronExpression

        public org.quartz.CronExpression getInitialAndOnErrorCronExpression()

      • setInitialAndOnErrorCronExpression

        public void setInitialAndOnErrorCronExpression​(org.quartz.CronExpression initialAndOnErrorCronExpression)

      • afterPropertiesSet

        public void afterPropertiesSet()
                        throws java.lang.Exception
        Specified by:
        afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean
        Throws:
        java.lang.Exception

      • readConfig

        public abstract boolean readConfig()
                            throws java.io.IOException
        Throws:
        java.io.IOException

      • isEnabled

        public boolean isEnabled()

      • setEnabled

        public void setEnabled​(boolean enabled)

      • setFirstTime

        protected void setFirstTime​(boolean firstTime)

      • getFirstTime

        protected boolean getFirstTime()

      • getLog

        protected abstract org.apache.commons.logging.Log getLog()

      • register

        public void register​(java.io.Reader reader,
                     java.lang.String readFrom)
              throws java.io.IOException
        Throws:
        java.io.IOException

      • register

        protected void register​(org.alfresco.transform.client.model.config.InlineTransformer transformer,
                        java.lang.String baseUrl,
                        java.lang.String readFrom)

      • isSupported

        public boolean isSupported​(java.lang.String sourceMimetype,
                           long sourceSizeInBytes,
                           java.lang.String targetMimetype,
                           java.util.Map<java.lang.String,​java.lang.String> actualOptions,
                           java.lang.String renditionName)
        Description copied from interface: TransformServiceRegistry
        Works out if the Transform Server should be able to transform content of a given source mimetype and size into a target mimetype given a list of actual transform option names and values (Strings) plus the data contained in the objects registered with this class.
        Specified by:
        isSupported in interface TransformServiceRegistry
        Parameters:
        sourceMimetype - the mimetype of the source content
        sourceSizeInBytes - the size in bytes of the source content. Ignored if negative.
        targetMimetype - the mimetype of the target
        actualOptions - the actual name value pairs available that could be passed to the Transform Service.
        renditionName - (optional) name for the set of options and target mimetype. If supplied is used to cache results to avoid having to work out if a given transformation is supported a second time. The sourceMimetype and sourceSizeInBytes may still change. In the case of ACS this is the rendition name.

      • getTransformerName

        protected java.lang.String getTransformerName​(java.lang.String sourceMimetype,
                                              long sourceSizeInBytes,
                                              java.lang.String targetMimetype,
                                              java.util.Map<java.lang.String,​java.lang.String> actualOptions,
                                              java.lang.String renditionName)
        Works out the name of the transformer (might not map to an actual transformer) that will be used to transform content of a given source mimetype and size into a target mimetype given a list of actual transform option names and values (Strings) plus the data contained in the objects registered with this class.
        Parameters:
        sourceMimetype - the mimetype of the source content
        sourceSizeInBytes - the size in bytes of the source content. Ignored if negative.
        targetMimetype - the mimetype of the target
        actualOptions - the actual name value pairs available that could be passed to the Transform Service.
        renditionName - (optional) name for the set of options and target mimetype. If supplied is used to cache results to avoid having to work out if a given transformation is supported a second time. The sourceMimetype and sourceSizeInBytes may still change. In the case of ACS this is the rendition name.

      • getMaxSize

        public long getMaxSize​(java.lang.String sourceMimetype,
                       java.lang.String targetMimetype,
                       java.util.Map<java.lang.String,​java.lang.String> actualOptions,
                       java.lang.String renditionName)
        Description copied from interface: TransformServiceRegistry
        Returns the maximun size (in bytes) of the source content that can be transformed.
        Specified by:
        getMaxSize in interface TransformServiceRegistry
        Parameters:
        sourceMimetype - the mimetype of the source content
        targetMimetype - the mimetype of the target
        actualOptions - the actual name value pairs available that could be passed to the Transform Service.
        renditionName - (optional) name for the set of options and target mimetype. If supplied is used to cache results to avoid having to work out if a given transformation is supported a second time. The sourceMimetype and sourceSizeInBytes may still change. In the case of ACS this is the rendition name.
        Returns:
        the maximum size (in bytes) of the source content that can be transformed. If -1 there is no limit, but if 0 the transform is not supported.