openaz-xacml-pdp/src/main/java/org/apache/openaz/xacml/pdp/std/functions/FunctionDefinitionURIStringConcatenate.java

/*
 *  Licensed to the Apache Software Foundation (ASF) under one
 *  or more contributor license agreements.  See the NOTICE file
 *  distributed with this work for additional information
 *  regarding copyright ownership.  The ASF licenses this file
 *  to you 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.
 *
 */

/*
 *                        AT&T - PROPRIETARY
 *          THIS FILE CONTAINS PROPRIETARY INFORMATION OF
 *        AT&T AND IS NOT TO BE DISCLOSED OR USED EXCEPT IN
 *             ACCORDANCE WITH APPLICABLE AGREEMENTS.
 *
 *          Copyright (c) 2013 AT&T Knowledge Ventures
 *              Unpublished and Not for Publication
 *                     All Rights Reserved
 */
package org.apache.openaz.xacml.pdp.std.functions;

import java.net.URI;
import java.util.List;

import org.apache.openaz.xacml.api.DataTypeException;
import org.apache.openaz.xacml.api.Identifier;
import org.apache.openaz.xacml.api.Status;
import org.apache.openaz.xacml.api.XACML;
import org.apache.openaz.xacml.pdp.eval.EvaluationContext;
import org.apache.openaz.xacml.pdp.policy.ExpressionResult;
import org.apache.openaz.xacml.pdp.policy.FunctionArgument;
import org.apache.openaz.xacml.std.StdAttributeValue;
import org.apache.openaz.xacml.std.StdStatus;
import org.apache.openaz.xacml.std.StdStatusCode;
import org.apache.openaz.xacml.std.datatypes.DataTypes;

/**
 * FunctionDefinitionURIStringConcatenate extends {@link FunctionDefinitionHomogeneousSimple} to implement the
 * XACML uri-string-concatenate predicate as a function taking one <code>URI</code> and one or more
 * <code>String</code> arguments and returning a single <code>URI</code> value. THIS FUNCTION IS DEPRECATED IN
 * 3.0 BUT NOT REMOVED. To provide backward compatibility for previously built XACML policies we include it in
 * our R3 version. In the first implementation of XACML we had separate files for each XACML Function. This
 * release combines multiple Functions in fewer files to minimize code duplication. This file supports the
 * following XACML codes: uri-string-concatenate
 */
@Deprecated
public class FunctionDefinitionURIStringConcatenate extends FunctionDefinitionBase<URI, URI> {

    /**
     * Constructor
     *
     * @param idIn
     * @param dataTypeArgsIn
     * @param op
     */
    public FunctionDefinitionURIStringConcatenate(Identifier idIn) {
        super(idIn, DataTypes.DT_ANYURI, DataTypes.DT_ANYURI, false);
    }

    @Override
    public ExpressionResult evaluate(EvaluationContext evaluationContext, List<FunctionArgument> arguments) {

        if (arguments == null || arguments.size() < 2) {
            return ExpressionResult.newError(new StdStatus(StdStatusCode.STATUS_CODE_PROCESSING_ERROR,
                                                           getShortFunctionId()
                                                               + " Expected 2 or more arguments, got "
                                                               + ((arguments == null) ? "null" : arguments
                                                                   .size())));
        }

        // get the string to search for
        ConvertedArgument<URI> uriArgument = new ConvertedArgument<URI>(arguments.get(0),
                                                                        DataTypes.DT_ANYURI, false);
        if (!uriArgument.isOk()) {
            Status decoratedStatus = new StdStatus(uriArgument.getStatus().getStatusCode(), uriArgument
                .getStatus().getStatusMessage() + " at arg index 0");
            return ExpressionResult.newError(getFunctionStatus(decoratedStatus));
        }
        String uriString = uriArgument.getValue().toString();

        // remaining arguments are strings
        String[] stringValues = new String[arguments.size() - 1];

        for (int i = 1; i < arguments.size(); i++) {

            ConvertedArgument<String> stringArgument = new ConvertedArgument<String>(arguments.get(i),
                                                                                     DataTypes.DT_STRING,
                                                                                     false);
            if (!stringArgument.isOk()) {
                Status decoratedStatus = new StdStatus(stringArgument.getStatus().getStatusCode(),
                                                       stringArgument.getStatus().getStatusMessage()
                                                           + " at arg index " + i);
                return ExpressionResult.newError(getFunctionStatus(decoratedStatus));
            }

            stringValues[i - 1] = stringArgument.getValue();

        }

        // add each of the strings onto the URI
        for (int i = 0; i < stringValues.length; i++) {
            uriString += stringValues[i];
        }

        URI resultURI = null;
        try {
            resultURI = DataTypes.DT_ANYURI.convert(uriString);
        } catch (DataTypeException e) {
            String message = e.getMessage();
            if (e.getCause() != null) {
                message = e.getCause().getMessage();
            }
            return ExpressionResult.newError(new StdStatus(StdStatusCode.STATUS_CODE_SYNTAX_ERROR,
                                                           getShortFunctionId() + " Final string '"
                                                               + uriString + "' not URI, " + message));
        }

        return ExpressionResult.newSingle(new StdAttributeValue<URI>(XACML.ID_DATATYPE_ANYURI, resultURI));

    }

}