org.alfresco.web.scripts

Class MimetypesQuery

java.lang.Object

org.springframework.extensions.webscripts.processor.BaseProcessorExtension

org.alfresco.web.scripts.SingletonValueProcessorExtension<Map<String,org.alfresco.web.scripts.Mimetype>>

org.alfresco.web.scripts.MimetypesQuery

All Implemented Interfaces:

Serializable, org.springframework.extensions.surf.core.processor.ProcessorExtension

public class MimetypesQuery
extends SingletonValueProcessorExtension<Map<String,org.alfresco.web.scripts.Mimetype>>
implements Serializable

Singleton templating host object provided to allows templates access to the Alfresco Repository Mimetypes information.

Service object that maintains no state other than the mimetypes info itself.

Author:

Nick Burch

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MimetypesQuery()

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,String>	getDisplaysByMimetype() Get all human readable mimetype descriptions, indexed by mimetype
String	getExtension(String mimetype) Get the extension for the specified mimetype
Map<String,String>	getMimetypesByDisplay() Gets all the human readable mimetype descriptions, sorted, along with their mimetypes.
protected String	getValueName() Output value name for informational and error messages to the administrator.
protected Map<String,org.alfresco.web.scripts.Mimetype>	retrieveValue(String userId, String storeId) Method for implementing class to provide that retrieve the remote value from the appropriate endpoint and API.
String	toString()

Methods inherited from class org.alfresco.web.scripts.SingletonValueProcessorExtension

getSingletonValue, getSingletonValue

Methods inherited from class org.springframework.extensions.webscripts.processor.BaseProcessorExtension

getExtensionName, register, setExtensionName, setProcessors

Methods inherited from class java.lang.Object

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

Constructor Detail

MimetypesQuery

public MimetypesQuery()

Method Detail

getDisplaysByMimetype

public Map<String,String> getDisplaysByMimetype()

Get all human readable mimetype descriptions, indexed by mimetype

Returns:

the map of displays indexed by mimetype

getMimetypesByDisplay

public Map<String,String> getMimetypesByDisplay()

Gets all the human readable mimetype descriptions, sorted, along with their mimetypes.

getExtension

public String getExtension(String mimetype)

Get the extension for the specified mimetype

Parameters:

mimetype - a valid mimetype

Returns:

Returns the default extension for the mimetype, or null if the mimetype is unknown

toString

public String toString()

Overrides:

toString in class Object

retrieveValue

protected Map<String,org.alfresco.web.scripts.Mimetype> retrieveValue(String userId,
                                                          String storeId)
                                                               throws org.springframework.extensions.surf.exception.ConnectorServiceException

Description copied from class: SingletonValueProcessorExtension

Method for implementing class to provide that retrieve the remote value from the appropriate endpoint and API. This is generally used to execute a REST API and extract a value from a response. The value is then automatically stored by the base class.

Specified by:

retrieveValue in class SingletonValueProcessorExtension<Map<String,org.alfresco.web.scripts.Mimetype>>

Parameters:

userId - Current user Id

storeId - Current store Id if any - may be used if per-tenant values are required

Returns:

value from the remote endpoint

Throws:

org.springframework.extensions.surf.exception.ConnectorServiceException

getValueName

protected String getValueName()

Description copied from class: SingletonValueProcessorExtension

Output value name for informational and error messages to the administrator.

Specified by:

getValueName in class SingletonValueProcessorExtension<Map<String,org.alfresco.web.scripts.Mimetype>>

Returns:

output value name