com.ibm.portal.pcm.events
Interface MapperFactory

All Known Implementing Classes:

AbstractCachingMapperFactory

public interface MapperFactory

A factory to create PayloadToContextMapper and ContextToPayloadMapper.

An implementation of this interface is configured in the platform in a plugin.xml file.

Sample plugin.xml:

 <plugin id="my.sample" name="Sample"
     version="1.0.0" provider-name="Sample">
     <extension point="com.ibm.portal.pcm.MapperFactory" id="MyMapperFactory">
         <factory class="my.sample.SampleMapperFactory"/>
     </extension>
 </plugin>

 
 

Since:

8.0.0

Method Summary

ContextToPayloadMapper	getContextToPayloadMapper(java.lang.String name) Returns an instance of the implementation of the specified ContextToPayloadMapper.
PayloadToContextMapper	getPayloadToContextMapper(java.lang.String name) Returns an instance of the implementation of the specified PayloadToContextMapper.

Method Detail

getPayloadToContextMapper

PayloadToContextMapper getPayloadToContextMapper(java.lang.String name)

Returns an instance of the implementation of the specified PayloadToContextMapper.

Must not throw an exception if the named class could not be found, instantiated or is of an invalid type. In this cases null must be returned.

If the class was found but could not be instantiated or is of an invalid type, this should be logged.

Parameters:

name - Name of the instance to instantiate.

Returns:

A PayloadToContextMapper instance associated to given name or null if an instance could not be created.

getContextToPayloadMapper

ContextToPayloadMapper getContextToPayloadMapper(java.lang.String name)

Returns an instance of the implementation of the specified ContextToPayloadMapper.

Must not throw an exception if the named class could not be found, instantiated or is of an invalid type. In this cases null must be returned.

If the class was found but could not be instantiated or is of an invalid type, this should be logged.

Parameters:

name - Name of the instance to instantiate.

Returns:

A ContextToPayloadMapper instance associated with the given name or null if an instance could not be created.