001package org.apache.maven.doxia.macro; 002 003/* 004 * Licensed to the Apache Software Foundation (ASF) under one 005 * or more contributor license agreements. See the NOTICE file 006 * distributed with this work for additional information 007 * regarding copyright ownership. The ASF licenses this file 008 * to you under the Apache License, Version 2.0 (the 009 * "License"); you may not use this file except in compliance 010 * with the License. You may obtain a copy of the License at 011 * 012 * http://www.apache.org/licenses/LICENSE-2.0 013 * 014 * Unless required by applicable law or agreed to in writing, 015 * software distributed under the License is distributed on an 016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 017 * KIND, either express or implied. See the License for the 018 * specific language governing permissions and limitations 019 * under the License. 020 */ 021 022import java.util.Map; 023import org.apache.maven.doxia.sink.Sink; 024import org.codehaus.plexus.component.annotations.Component; 025 026/** 027 * Server-Side Include directive, to insert a SSI into the output. 028 * Required parameter is <code>function</code> to define SSI function, then 029 * additional parameters are completely free. 030 * 031 * @since 1.7 032 */ 033@Component( role = Macro.class, hint = "ssi" ) 034public class SsiMacro 035 extends AbstractMacro 036{ 037 private static final String PARAM_FUNCTION = "function"; 038 039 private boolean isInternalParameter( String name ) 040 { 041 return PARAM_FUNCTION.equals( name ) || MacroRequest.isInternalParameter( name ); 042 } 043 /** {@inheritDoc} */ 044 public void execute( Sink sink, MacroRequest request ) 045 throws MacroExecutionException 046 { 047 String function = (String) request.getParameter( PARAM_FUNCTION ); 048 049 required( PARAM_FUNCTION, function ); 050 051 StringBuilder buff = new StringBuilder(); 052 buff.append( '#' ); 053 buff.append( function ); 054 055 for ( Map.Entry<String, Object> entry : request.getParameters().entrySet() ) 056 { 057 if ( !isInternalParameter( entry.getKey() ) ) 058 { 059 buff.append( ' ' ); 060 buff.append( entry.getKey() ); 061 buff.append( "=\"" ); 062 buff.append( entry.getValue() ); 063 buff.append( '"' ); 064 } 065 } 066 067 buff.append( ' ' ); 068 sink.comment( buff.toString() ); 069 } 070}