com.novartis.opensource.yada.plugin.SecurityPluginDetector Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of yada-api Show documentation
The newest version!
/**
 * 
 */
package com.novartis.opensource.yada.plugin;

import java.lang.annotation.Annotation;
import java.sql.ResultSet;
import java.sql.SQLException;

import javax.sql.rowset.CachedRowSet;
import javax.sql.rowset.RowSetMetaDataImpl;
import javax.sql.rowset.RowSetProvider;

import org.apache.log4j.Logger;

import com.novartis.opensource.yada.Service;
import com.novartis.opensource.yada.YADAQuery;
import com.novartis.opensource.yada.YADARequest;
import com.novartis.opensource.yada.YADASecurityException;

/**
 * Determines if a default query parameter is a {@code plugin} and if so, 
 * if it refers to a {@link Preprocess} plugin with a {@link SecurityPreprocessor} 
 * annotation. 
 * @author varontron
 * @since 8.7.6
 *
 */
public class SecurityPluginDetector extends AbstractPostprocessor {
	/**
	 * Local logger handle
	 */
	private static Logger l = Logger.getLogger(Service.class);
	/**
	 * The {@code NAME} column
	 */
	private final static String NAME_U   = "NAME";
	/**
	 * The {@code VALUE} column
	 */
	private final static String VALUE_U  = "VALUE";
	/**
	 * The {@code SPP} or SecurityPreprocessor flag column
	 */
	private final static String SPP_U    = "SPP";
	/**
	 * The {@code name} column
	 */
	private final static String NAME_L   = "name";
	/**
	 * The {@code value} column
	 */
	private final static String VALUE_L  = "value";
	/**
	 * The {@code spp} or SecurityPreprocessor flag column
	 */
	private final static String SPP_L    = "spp";
	/**
	 * The {@code pl} parameter
	 */
	private final static String PLUGIN = "pl";
	
	/**
	 * Creates a {@link javax.sql.rowset.CachedRowSet} from the {@link java.sql.ResultSet}
	 * stored in the {@link YADAQuery}, containing the results of the query for stored
	 * query parameters.  It then adds a column to the 
	 * {@link javax.sql.rowset.CachedRowSet} to store a boolean value as a string indicating
	 * if a) the parameter refers to a {@code plugin}, and b) if the referenced plugin has
	 * a {@link SecurityPreprocessor} annotation. 
	 */
	@Override
	public void engage(YADAQuery yq) throws YADAPluginException, YADASecurityException
	{
		super.engage(yq);		
		try 
		{
			ResultSet    rs  = (ResultSet) yq.getResult().getResult(0);			
			CachedRowSet crs = RowSetProvider.newFactory().createCachedRowSet();
			String name = NAME_U, 
					   value = VALUE_U, 
					   spp = SPP_U;
			crs.populate(rs);
			
			// update metadata
			RowSetMetaDataImpl crsmd = (RowSetMetaDataImpl) crs.getMetaData();
			crsmd.setColumnCount(rs.getMetaData().getColumnCount());			
			for(int i=1;i<=crsmd.getColumnCount();i++)
			{
				crsmd.setColumnName(i, rs.getMetaData().getColumnName(i));
				crsmd.setColumnType(i, rs.getMetaData().getColumnType(i));
			}
			
			// case sensitivity
			if(crsmd.getColumnName(1).matches("[a-z]+"))
			{
				name = NAME_L;
				value = VALUE_L;
				spp = SPP_L;
			}
			
			// populate column six
			while(crs.next())
			{
				
				if(crs.getString(name).equals(PLUGIN))
				{
					String plugin = crs.getString(value).split(",")[0];
	  			Class pluginClass;
	  			try 
	  			{
	  				pluginClass = plugin.indexOf(YADARequest.PLUGIN_PKG) > -1 
	  						? Class.forName(plugin) 
	  						: Class.forName(YADARequest.PLUGIN_PKG + "." + plugin);
	  				Annotation secPlugin = pluginClass.getAnnotation(SecurityPreprocessor.class);
	  				if(secPlugin != null && secPlugin instanceof SecurityPreprocessor)
	  				{
	  					crs.updateString(spp, "true");
	  				}	  				
	  			} 
	  			catch (ClassNotFoundException e) 
	  			{
	  				String msg = "Could not find any plugin with the classname ["+plugin+"]"; 
						l.error(msg,e);
	  			}		
			  }
			}
			crs.beforeFirst();
			yq.getResult().setResult(0, crs);
		} 
		catch (SQLException e) 
		{
			String msg = "Unable to interrogate ResultSet";
			throw new YADAPluginException(msg,e);
		}
	}
}