org.apache.cxf.transport.servlet.servicelist.FormattedServiceListWriter Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of cxf-bundle-minimal Show documentation
Apache CXF Minimal Bundle Jar
There is a newer version: 2.7.18
/**
 * 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.
 */
package org.apache.cxf.transport.servlet.servicelist;

import java.io.IOException;
import java.io.PrintWriter;
import java.util.Map;

import org.apache.cxf.service.model.OperationInfo;
import org.apache.cxf.transport.AbstractDestination;

public class FormattedServiceListWriter implements ServiceListWriter {
    private String styleSheetPath;
    private String title;
    private Map atomMap;
    private boolean showForeignContexts;
    
    public FormattedServiceListWriter(String styleSheetPath, 
                                      String title,
                                      boolean showForeignContexts,
                                      Map atomMap) {
        this.styleSheetPath = styleSheetPath;
        this.title = title;
        this.showForeignContexts = showForeignContexts;
        this.atomMap = atomMap;
    }

    public String getContentType() {
        return "text/html; charset=UTF-8";
    }

    public void writeServiceList(PrintWriter writer,
                                 String basePath,
                                 AbstractDestination[] soapDestinations,
                                 AbstractDestination[] restDestinations) throws IOException {
        writer.write("");
        writer.write("");
        writer.write("");
        writer.write("");
        if (title != null) {
            writer.write("" + title + "");
        } else {
            writer.write("CXF - Service list");
        }
        writer.write("");

        if (soapDestinations.length > 0 || restDestinations.length > 0) {
            writeSOAPEndpoints(writer, basePath, soapDestinations);
            writeRESTfulEndpoints(writer, basePath, restDestinations);
        } else {
            writer.write("No services have been found.");
        }

        writer.write("");
    }

    private void writeSOAPEndpoints(PrintWriter writer,
                                    String basePath,
                                    AbstractDestination[] destinations)
        throws IOException {
        writer.write("Available SOAP services:
");
        writer.write("");
        for (AbstractDestination sd : destinations) {
            writerSoapEndpoint(writer, basePath, sd);
        }
        writer.write("


");
    }

    private void writerSoapEndpoint(PrintWriter writer,
                                    String basePath,
                                    AbstractDestination sd) {
        String absoluteURL = getAbsoluteAddress(basePath, sd);
        if (absoluteURL == null) {
            return;
        }
        
        writer.write("");
        writer.write(""
                     + sd.getEndpointInfo().getInterface().getName().getLocalPart() + "");
        writer.write("");
        for (OperationInfo oi : sd.getEndpointInfo().getInterface().getOperations()) {
            if (oi.getProperty("operation.is.synthetic") != Boolean.TRUE) {
                writer.write("" + oi.getName().getLocalPart() + "");
            }
        }
        writer.write("");
        writer.write("");
        
        
        writer.write("Endpoint address: " + ""
                     + absoluteURL + "");
        writer.write("
WSDL : " + "" + sd.getEndpointInfo().getService().getName() + "");
        writer.write("
Target namespace: "
                     + ""
                     + sd.getEndpointInfo().getService().getTargetNamespace() + "");
        addAtomLinkIfNeeded(absoluteURL, atomMap, writer);
        writer.write("");
    }

    private String getAbsoluteAddress(String basePath, AbstractDestination d) {
        String endpointAddress = (String)d.getEndpointInfo().getProperty("publishedEndpointUrl");
        if (endpointAddress != null) {
            return endpointAddress;
        }
        endpointAddress = d.getEndpointInfo().getAddress();
        if (endpointAddress.startsWith("http://") || endpointAddress.startsWith("https://")) {
            if (endpointAddress.startsWith(basePath) || showForeignContexts) {
                return endpointAddress;
            } else {
                return null;
            }
        } else {
            return basePath + endpointAddress;
        }
    }
    
    private void writeRESTfulEndpoints(PrintWriter writer, 
                                       String basePath, 
                                       AbstractDestination[] restfulDests)
        throws IOException {
        writer.write("Available RESTful services:
");
        writer.write("");
        for (AbstractDestination sd : restfulDests) {
            writeRESTfulEndpoint(writer, basePath, sd);
        }
        writer.write("");
    }

    private void writeRESTfulEndpoint(PrintWriter writer,
                                      String basePath,
                                      AbstractDestination sd) {
        String absoluteURL = getAbsoluteAddress(basePath, sd);
        if (absoluteURL == null) {
            return;
        }
        
        writer.write("");
        writer.write("Endpoint address: " + ""
                     + absoluteURL + "");
        writer.write("
WADL : " + "" + absoluteURL + "?_wadl" + "");
        addAtomLinkIfNeeded(absoluteURL, atomMap, writer);
        writer.write("");
    }

    private static void addAtomLinkIfNeeded(String address, Map extMap, PrintWriter pw) {
        String atomAddress = getExtensionEndpointAddress(address, extMap);
        if (atomAddress != null) {
            pw.write("
Atom Log Feed : " + "" + atomAddress + "");
        }
    }

    private static String getExtensionEndpointAddress(String endpointAddress, Map extMap) {
        if (extMap != null) {
            for (Map.Entry entry : extMap.entrySet()) {
                if (endpointAddress.endsWith(entry.getKey())) {
                    endpointAddress = endpointAddress.substring(0, endpointAddress.length()
                                                                   - entry.getKey().length());
                    endpointAddress += entry.getValue();
                    return endpointAddress;
                }
            }
        }
        return null;
    }

}