org.forgerock.openicf.maven

Class ConnectorDocBuilder

java.lang.Object

org.forgerock.openicf.maven.ConnectorDocBuilder

public class ConnectorDocBuilder
extends Object

A ConnectorDocBuilder .

Author:

Laszlo Hordos

Field Summary

Fields

Modifier and Type	Field and Description
protected static List<Class<? extends APIOperation>>	OBJECTCLASS_OPERATIONS
protected static Map<Class<? extends APIOperation>,Pair<String,String>>	OP_DICTIONARY
protected static List<Class<? extends APIOperation>>	OPERATIONS

Constructor Summary

Constructors

Constructor and Description
ConnectorDocBuilder(org.forgerock.openicf.maven.ConnectorMojoBridge bridge)

Method Summary

Modifier and Type	Method and Description
protected void	executeReport() Execute the generation of the report.
ConnectorInfoManager	getConnectorInfoManager()
List<ConnectorInfo>	listAllConnectorInfo()
void	processTemplate(org.apache.velocity.app.VelocityEngine engine, org.apache.velocity.context.Context context, String templateName, Writer writer) Create the velocity template

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

OBJECTCLASS_OPERATIONS

protected static final List<Class<? extends APIOperation>> OBJECTCLASS_OPERATIONS

OPERATIONS

protected static final List<Class<? extends APIOperation>> OPERATIONS

OP_DICTIONARY

protected static final Map<Class<? extends APIOperation>,Pair<String,String>> OP_DICTIONARY

Constructor Detail

ConnectorDocBuilder

public ConnectorDocBuilder(org.forgerock.openicf.maven.ConnectorMojoBridge bridge)

Method Detail

executeReport

protected void executeReport()
                      throws org.apache.maven.plugin.MojoExecutionException

Execute the generation of the report.

Throws:

org.apache.maven.reporting.MavenReportException - if any

org.apache.maven.plugin.MojoExecutionException

processTemplate

public void processTemplate(org.apache.velocity.app.VelocityEngine engine,
                            org.apache.velocity.context.Context context,
                            String templateName,
                            Writer writer)
                     throws org.apache.maven.plugin.MojoExecutionException

Create the velocity template

Parameters:

context - velocity context that has the parameter values

templateName - velocity template which will the context be merged

Throws:

org.apache.velocity.exception.ResourceNotFoundException - , VelocityException, IOException

org.apache.maven.plugin.MojoExecutionException

listAllConnectorInfo

public List<ConnectorInfo> listAllConnectorInfo()
                                         throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

getConnectorInfoManager

public ConnectorInfoManager getConnectorInfoManager()
                                             throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException