org.jboss.security.mapping.MappingProvider Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jboss-security-spi

PicketBox is a security project for Java Applications

The newest version!

/*
 * JBoss, the OpenSource J2EE webOS
 *
 * Distributable under LGPL license.
 * See terms of license at gnu.org.
 */ 
package org.jboss.security.mapping;

import java.util.Map;

/**
 *  A provider with mapping functionality
 *  @author Anil Saldhana
 *  @version $Revision$
 * @param 
 *  @since  Aug 24, 2006
 */
public interface MappingProvider
{
   /**
    * Initialize the provider with the configured module options
    * @param options
    */
   void init(Map options);
   
   /**
    * Map the passed object
    * @param map A read-only contextual map that can provide information to the provider
    * @param mappedObject an Object on which the mapping will be applied 
    * @throws IllegalArgumentException if the mappedObject is not understood by the 
    * provider.
    */
    void performMapping(Map map, T mappedObject);
    
    /**
     * Injected by the MappingContext
     * @param result
     */
    void setMappingResult(MappingResult result);
    
    /**
     * Whether this mapping provider supports
     * mapping T
     * @param t
     * @return
     */
    boolean supports(Class p);
}