org.kuali.maven.plugin.ksite.mojo
Class KualiSiteMojo

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      org.kuali.maven.plugin.ksite.mojo.KualiSiteMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.kuali.maven.common.SiteContext

public class KualiSiteMojo
extends org.apache.maven.plugin.AbstractMojo
implements org.kuali.maven.common.SiteContext

This plugin organizes/standardizes the maven site publication process for the Kuali organization

Field Summary

private String	bucket The name of the AWS bucket the site gets published to
private String	downloadPrefix The prefix for the location that artifacts can be downloaded from
private String	downloadReleasePrefix The prefix into the bucket when downloading a release version
private String	downloadSnapshotPrefix The prefix into the bucket when downloading a snapshot version
private String	hostname The public DNS name for the site
private String	organizationGroupId The groupId for the organization
private org.apache.maven.project.MavenProject	project The Maven project this plugin runs in.
private String	publicUrlProtocol The protocol for the public facing website
private String	publishUrlProtocol The protocol used when publishing the web site

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

KualiSiteMojo()

Method Summary

void	execute()
String	getBucket()
String	getDownloadPrefix()
String	getDownloadReleasePrefix()
String	getDownloadSnapshotPrefix()
String	getHostname()
String	getOrganizationGroupId()
org.apache.maven.project.MavenProject	getProject()
String	getPublicUrlProtocol()
String	getPublishUrlProtocol()
protected void	handleDownloadUrl(String downloadUrl, org.apache.maven.model.DistributionManagement dm)
protected void	handlePublicUrl(String publicUrl, org.apache.maven.project.MavenProject project)
protected void	handlePublishUrl(String publishUrl, org.apache.maven.model.Site site)
protected boolean	isReplace(String s, String token) Return true if "s" is empty or contains "token"
protected boolean	isUrlMatch(String url1, String url2) Return true if the 2 urls are exactly the same or if the only thing different about them is a trailing slash
void	setBucket(String bucket)
void	setDownloadPrefix(String downloadPrefix)
void	setDownloadReleasePrefix(String downloadReleasePrefix)
void	setDownloadSnapshotPrefix(String downloadSnapshotPrefix)
void	setHostname(String hostname)
void	setOrganizationGroupId(String parentGroupId)
void	setProject(org.apache.maven.project.MavenProject project)
void	setPublicUrlProtocol(String publicUrlProtocol)
void	setPublishUrlProtocol(String publishUrlProtocol)
protected void	warn(String pomString, String calculatedString, String propertyDescription)

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

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

Field Detail

downloadSnapshotPrefix

private String downloadSnapshotPrefix

The prefix into the bucket when downloading a snapshot version

downloadReleasePrefix

private String downloadReleasePrefix

The prefix into the bucket when downloading a release version

publishUrlProtocol

private String publishUrlProtocol

The protocol used when publishing the web site

publicUrlProtocol

private String publicUrlProtocol

The protocol for the public facing website

downloadPrefix

private String downloadPrefix

The prefix for the location that artifacts can be downloaded from

organizationGroupId

private String organizationGroupId

The groupId for the organization

bucket

private String bucket

The name of the AWS bucket the site gets published to

hostname

private String hostname

The public DNS name for the site

project

private org.apache.maven.project.MavenProject project

The Maven project this plugin runs in.

Constructor Detail

KualiSiteMojo

public KualiSiteMojo()

Method Detail

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException,
                    org.apache.maven.plugin.MojoFailureException

Specified by:

execute in interface org.apache.maven.plugin.Mojo

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

isReplace

protected boolean isReplace(String s,
                            String token)

Return true if "s" is empty or contains "token"

warn

protected void warn(String pomString,
                    String calculatedString,
                    String propertyDescription)

isUrlMatch

protected boolean isUrlMatch(String url1,
                             String url2)

Return true if the 2 urls are exactly the same or if the only thing different about them is a trailing slash

handleDownloadUrl

protected void handleDownloadUrl(String downloadUrl,
                                 org.apache.maven.model.DistributionManagement dm)

handlePublishUrl

protected void handlePublishUrl(String publishUrl,
                                org.apache.maven.model.Site site)

handlePublicUrl

protected void handlePublicUrl(String publicUrl,
                               org.apache.maven.project.MavenProject project)

getProject

public org.apache.maven.project.MavenProject getProject()

Returns:

the project

setProject

public void setProject(org.apache.maven.project.MavenProject project)

Parameters:

project - the project to set

getBucket

public String getBucket()

Specified by:

getBucket in interface org.kuali.maven.common.SiteContext

Returns:

the bucket

setBucket

public void setBucket(String bucket)

Parameters:

bucket - the bucket to set

getHostname

public String getHostname()

Specified by:

getHostname in interface org.kuali.maven.common.SiteContext

Returns:

the hostname

setHostname

public void setHostname(String hostname)

Parameters:

hostname - the hostname to set

getDownloadPrefix

public String getDownloadPrefix()

Specified by:

getDownloadPrefix in interface org.kuali.maven.common.SiteContext

Returns:

the downloadPrefix

setDownloadPrefix

public void setDownloadPrefix(String downloadPrefix)

Parameters:

downloadPrefix - the downloadPrefix to set

getOrganizationGroupId

public String getOrganizationGroupId()

Specified by:

getOrganizationGroupId in interface org.kuali.maven.common.SiteContext

Returns:

the parentGroupId

setOrganizationGroupId

public void setOrganizationGroupId(String parentGroupId)

Parameters:

parentGroupId - the parentGroupId to set

getPublishUrlProtocol

public String getPublishUrlProtocol()

Specified by:

getPublishUrlProtocol in interface org.kuali.maven.common.SiteContext

Returns:

the publishUrlProtocol

setPublishUrlProtocol

public void setPublishUrlProtocol(String publishUrlProtocol)

Parameters:

publishUrlProtocol - the publishUrlProtocol to set

getPublicUrlProtocol

public String getPublicUrlProtocol()

Specified by:

getPublicUrlProtocol in interface org.kuali.maven.common.SiteContext

Returns:

the publicUrlProtocol

setPublicUrlProtocol

public void setPublicUrlProtocol(String publicUrlProtocol)

Parameters:

publicUrlProtocol - the publicUrlProtocol to set

getDownloadSnapshotPrefix

public String getDownloadSnapshotPrefix()

Specified by:

getDownloadSnapshotPrefix in interface org.kuali.maven.common.SiteContext

Returns:

the downloadSnapshotPrefix

setDownloadSnapshotPrefix

public void setDownloadSnapshotPrefix(String downloadSnapshotPrefix)

Parameters:

downloadSnapshotPrefix - the downloadSnapshotPrefix to set

getDownloadReleasePrefix

public String getDownloadReleasePrefix()

Specified by:

getDownloadReleasePrefix in interface org.kuali.maven.common.SiteContext

Returns:

the downloadReleasePrefix

setDownloadReleasePrefix

public void setDownloadReleasePrefix(String downloadReleasePrefix)

Parameters:

downloadReleasePrefix - the downloadReleasePrefix to set