PortalURLResourceProvider.java

/*
 * JBoss, Home of Professional Open Source.
 * Copyright 2013, Red Hat, Inc., and individual contributors
 * as indicated by the @author tags. See the copyright.txt file in the
 * distribution for a full listing of individual contributors.
 *
 * 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.jboss.arquillian.portal.impl.enricher.resource;

import java.lang.annotation.Annotation;
import java.net.URL;
import java.util.Collection;

import org.jboss.arquillian.container.test.impl.enricher.resource.URLResourceProvider;
import org.jboss.arquillian.core.api.Injector;
import org.jboss.arquillian.core.api.Instance;
import org.jboss.arquillian.core.api.annotation.Inject;
import org.jboss.arquillian.core.spi.ServiceLoader;
import org.jboss.arquillian.portal.api.PortalURL;
import org.jboss.arquillian.portal.impl.PortletArchiveMetadata;
import org.jboss.arquillian.portal.spi.enricher.resource.PortalURLProvider;
import org.jboss.arquillian.test.api.ArquillianResource;
import org.jboss.arquillian.test.spi.TestClass;
import org.jboss.arquillian.test.spi.enricher.resource.ResourceProvider;

/**
 * @author <a href="mailto:ken@kenfinnigan.me">Ken Finnigan</a>
 */
public class PortalURLResourceProvider implements ResourceProvider {

    @Inject
    private Instance<Injector> injector;

    @Inject
    private Instance<TestClass> testClass;

    @Inject
    Instance<ServiceLoader> loader;

    @Inject
    Instance<PortletArchiveMetadata> portletMetadata;

    private URLResourceProvider urlResourceProvider = new URLResourceProvider();

    @Override
    public boolean canProvide(Class<?> type) {
        return URL.class.isAssignableFrom(type);
    }

    @Override
    public Object lookup(ArquillianResource resource, Annotation... qualifiers) {
        boolean found = false;
        PortalURL portalURL = null;
        for (Annotation annotation : qualifiers) {
            if(PortalURL.class.isAssignableFrom(annotation.annotationType())) {
                portalURL = PortalURL.class.cast(annotation);
                found = true;
                break;
            }
        }

        if (!found) {
            return lookupBaseUrl(resource, qualifiers);
        }

        return locateURL(resource, qualifiers, portalURL);
    }

    protected Object lookupBaseUrl(ArquillianResource resource, Annotation... qualifiers) {
        injector().inject(urlResourceProvider);

        return urlResourceProvider.lookup(resource, qualifiers);
    }

    protected Injector injector() {
        return injector.get();
    }

    private Object locateURL(ArquillianResource resource, Annotation[] qualifiers, PortalURL portalURL) {
        return toURL((URL) lookupBaseUrl(resource, qualifiers), portalURL);
    }

    private URL toURL(URL original, PortalURL portalURL) {
        Collection<PortalURLProvider> providers = loader.get().all(PortalURLProvider.class);
        String[] portlets = getPortletList(portalURL);
        for (PortalURLProvider provider : providers) {
            try {
                return provider.customizeURL(original, portlets);
            } catch (Exception e) {
                throw new RuntimeException("Failed to create portal specific url based on " + original + " from provider: "
                        + provider, e);
            }
        }
        return original;
    }

    private String[] getPortletList(PortalURL portalURL) {
        String[] portlets = portalURL.value();
        if (portlets.length > 0 && portlets[0].length() > 0) {
            return portlets;
        }

        // Default behavior when no portlets specified, retrieve all portlets from portlet.xml
        portlets = portletMetadata.get().getPortletNames().toArray(portlets);
        return portlets;
    }
}