/*
 * Copyright 2006-2012 the original author or authors.
 *
 * 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.citrusframework.functions.core;

import org.citrusframework.context.TestContext;
import org.citrusframework.exceptions.CitrusRuntimeException;
import org.citrusframework.exceptions.InvalidFunctionUsageException;
import org.citrusframework.functions.Function;

import java.net.InetAddress;
import java.net.UnknownHostException;
import java.util.List;

/**
 * Function gets the local host address. Usually some IP address (e.g. 192.168.2.100).
 * This enables us to access the localhost dynamically in tests.
 * 
 * @author Christoph Deppisch
 */
public class LocalHostAddressFunction implements Function {

    /**
     * {@inheritDoc}
     */
    public String execute(List<String> parameterList, TestContext context) {
        if (!parameterList.isEmpty()) {
            throw new InvalidFunctionUsageException("Unexpected parameter for function.");
        }
        
        try {
            return InetAddress.getLocalHost().getHostName();
        } catch (UnknownHostException e) {
            throw new CitrusRuntimeException("Unable to locate local host address", e);
        }
    }

}

