CipherTag.java

/**
 * Copyright 2005-2016 hdiv.org
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * 	http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.hdiv.tags;

import java.io.IOException;

import javax.servlet.jsp.JspException;
import javax.servlet.jsp.JspWriter;
import javax.servlet.jsp.tagext.TagSupport;

import org.hdiv.dataComposer.IDataComposer;
import org.hdiv.util.HDIVUtil;

/**
 * Tag to cipher data without using a framework tag.f
 * <p>
 * Being "hdiv" the identifier used to reference HDIV tag library, the format of the tag will be as follows:
 * <code><hdiv:cipher action="a1" parameter="p1" value="v1" /></code>.
 * </p>
 * <p>
 * The result will be an encoded value that only HDIV can interpret.
 * </p>
 *
 * @author Gorka Vicente
 * @since HDIV 2.0.6
 */
public class CipherTag extends TagSupport {

	/**
	 * Universal version identifier. Deserialization uses this number to ensure that a loaded class corresponds exactly to a serialized
	 * object.
	 */
	private static final long serialVersionUID = -5223047708438702403L;

	/**
	 * Sets the action <code>action</code> defined in the tag.
	 *
	 * @param action Action
	 */
	public void setAction(final String action) {
		setValue("action", action);
	}

	/**
	 * Sets the parameter <code>parameter</code> defined in the tag.
	 *
	 * @param parameter Parameter
	 */
	public void setParameter(final String parameter) {
		setValue("parameter", parameter);
	}

	/**
	 * Sets the value <code>value</code> defined in the tag.
	 *
	 * @param value Value
	 */
	public void setValue(final String value) {
		setValue("value", value);
	}

	/**
	 * Sets the value <code>var</code> defined in the tag.
	 *
	 * @param var Variable
	 */
	public void setVar(final String var) {
		setValue("var", var);
	}

	/**
	 * Process the start of this tag.
	 *
	 * @throws JspException If the attributes passed to the tag are incorrect, an exception will be thrown.
	 */
	@Override
	public int doStartTag() throws JspException {

		IDataComposer dataComposer = HDIVUtil.getRequestContext(pageContext.getRequest()).getDataComposer();

		String action = (String) getValue("action");
		String parameter = (String) getValue("parameter");
		String value = (String) getValue("value");
		String var = (String) getValue("var");

		String cipheredValue;
		if (action != null) {
			cipheredValue = dataComposer.compose(action, parameter, value, false);
		}
		else {
			cipheredValue = dataComposer.compose(parameter, value, false);
		}

		try {
			// getJspWriter to output content
			if (var != null) {
				pageContext.setAttribute(var, cipheredValue);
			}
			else {
				JspWriter out = pageContext.getOut();
				out.print(cipheredValue);
			}
		}
		catch (IOException e) {
			throw new JspException("Error:" + e.getMessage(), e);
		}

		return SKIP_BODY;
	}

}