forked from FantasyNitroGEN/visallo
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' into work-products-merge-with-master
- Loading branch information
Showing
172 changed files
with
4,471 additions
and
979 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| # Maven Archetype for Visallo Plugin Development | ||
|
|
||
| This project is a [Maven Archetype](https://maven.apache.org/guides/introduction/introduction-to-archetypes.html) designed to help outside developers get started with writing Visallo plugins. It provides a recommended Maven project structure and a working set of plugin modules (UI, Graph Property Worker, and Authentication). Developers can use these modules as starting points for creating their own plugins. | ||
|
|
||
| ### Testing the Archetype | ||
|
|
||
| When `mvn install` is run, a sample project is automatically generated from the archetype as a convenient way to test it. Use the following commands to fully build the archetype and run Visallo using the generated sample project: | ||
| ``` | ||
| mvn install | ||
| cd target/test-classes/projects/basic/project/basic | ||
| ./run.sh | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| #!/bin/bash -eu | ||
|
|
||
| # Build the archetype and install to local Maven repo. This is the only way for the test project to be generated. | ||
| mvn clean install | ||
|
|
||
| # Compile and test the generated test project. | ||
| mvn -f target/test-classes/projects/basic/project/basic/pom.xml test |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,76 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <project xmlns="http://maven.apache.org/POM/4.0.0" | ||
| xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" | ||
| xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> | ||
| <modelVersion>4.0.0</modelVersion> | ||
|
|
||
| <parent> | ||
| <groupId>org.sonatype.oss</groupId> | ||
| <artifactId>oss-parent</artifactId> | ||
| <version>7</version> | ||
| </parent> | ||
|
|
||
| <groupId>org.visallo</groupId> | ||
| <artifactId>visallo-plugin-archetype</artifactId> | ||
| <version>2.2-SNAPSHOT</version> | ||
| <packaging>maven-archetype</packaging> | ||
|
|
||
| <name>Visallo: Maven Archetype</name> | ||
| <description>Generate a project for Visallo plugin development</description> | ||
|
|
||
|
|
||
| <properties> | ||
| <plugin.maven.archetype.version>2.4</plugin.maven.archetype.version> | ||
| <maven.plugin.gpg.version>1.6</maven.plugin.gpg.version> | ||
| </properties> | ||
|
|
||
| <profiles> | ||
| <profile> | ||
| <id>release-tasks</id> | ||
| <activation> | ||
| <!-- mvn release:perform sets this to true --> | ||
| <property> | ||
| <name>performRelease</name> | ||
| <value>true</value> | ||
| </property> | ||
| </activation> | ||
| <build> | ||
| <plugins> | ||
| <plugin> | ||
| <groupId>org.apache.maven.plugins</groupId> | ||
| <artifactId>maven-gpg-plugin</artifactId> | ||
| <version>${maven.plugin.gpg.version}</version> | ||
| <executions> | ||
| <execution> | ||
| <id>sign-artifacts</id> | ||
| <phase>verify</phase> | ||
| <goals> | ||
| <goal>sign</goal> | ||
| </goals> | ||
| </execution> | ||
| </executions> | ||
| </plugin> | ||
| </plugins> | ||
| </build> | ||
| </profile> | ||
| </profiles> | ||
|
|
||
| <build> | ||
| <extensions> | ||
| <extension> | ||
| <groupId>org.apache.maven.archetype</groupId> | ||
| <artifactId>archetype-packaging</artifactId> | ||
| <version>${plugin.maven.archetype.version}</version> | ||
| </extension> | ||
| </extensions> | ||
|
|
||
| <pluginManagement> | ||
| <plugins> | ||
| <plugin> | ||
| <artifactId>maven-archetype-plugin</artifactId> | ||
| <version>${plugin.maven.archetype.version}</version> | ||
| </plugin> | ||
| </plugins> | ||
| </pluginManagement> | ||
| </build> | ||
| </project> |
132 changes: 132 additions & 0 deletions
132
archetype/src/main/resources/META-INF/maven/archetype-metadata.xml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,132 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <archetype-descriptor xsi:schemaLocation="http://maven.apache.org/plugins/maven-archetype-plugin/archetype-descriptor/1.0.0 http://maven.apache.org/xsd/archetype-descriptor-1.0.0.xsd" | ||
| name="example-visallo-plugins" | ||
| xmlns="http://maven.apache.org/plugins/maven-archetype-plugin/archetype-descriptor/1.0.0" | ||
| xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> | ||
| <requiredProperties> | ||
| <requiredProperty key="ontologyBaseIri"> | ||
| <!-- | ||
| NOTE: There is a bug in Maven where the user won't be prompted for the value of a property unless | ||
| there's an expression present in defaultValue. Thus, it works in this case because ${artifactId} is | ||
| part of defaultValue for ontologyBaseIri. | ||
| https://issues.apache.org/jira/browse/ARCHETYPE-308 | ||
| http://stackoverflow.com/questions/3895175/ask-for-maven-archetype-properties-with-defaults | ||
| --> | ||
| <defaultValue>http://example.org/${artifactId}</defaultValue> | ||
| </requiredProperty> | ||
| </requiredProperties> | ||
| <fileSets> | ||
| <fileSet filtered="true" encoding="UTF-8"> | ||
| <directory>config</directory> | ||
| <includes> | ||
| <include>*.properties</include> | ||
| </includes> | ||
| </fileSet> | ||
| <fileSet filtered="false" encoding="UTF-8"> | ||
| <directory>config</directory> | ||
| <includes> | ||
| <include>*.jks</include> | ||
| </includes> | ||
| </fileSet> | ||
| <fileSet filtered="true" encoding="UTF-8"> | ||
| <directory>config/ontology</directory> | ||
| <includes> | ||
| <include>*.owl</include> | ||
| </includes> | ||
| </fileSet> | ||
| <fileSet encoding="UTF-8"> | ||
| <directory>config/ontology</directory> | ||
| <includes> | ||
| <include>*.png</include> | ||
| </includes> | ||
| </fileSet> | ||
| <fileSet encoding="UTF-8"> | ||
| <directory/> | ||
| <includes> | ||
| <include>gitignore</include> | ||
| <include>README.md</include> | ||
| <include>*.sh</include> | ||
| </includes> | ||
| </fileSet> | ||
| </fileSets> | ||
| <modules> | ||
| <module id="${rootArtifactId}-auth" dir="plugins/auth" name="${rootArtifactId}-auth"> | ||
| <fileSets> | ||
| <fileSet filtered="true" packaged="true" encoding="UTF-8"> | ||
| <directory>src/main/java</directory> | ||
| <includes> | ||
| <include>**/*.java</include> | ||
| </includes> | ||
| </fileSet> | ||
| <fileSet filtered="true" encoding="UTF-8"> | ||
| <directory>src/main/resources</directory> | ||
| <includes> | ||
| <include>**/*.properties</include> | ||
| <include>**/*.WebAppPlugin</include> | ||
| <include>**/*.css</include> | ||
| <include>**/*.hbs</include> | ||
| <include>**/*.js</include> | ||
| </includes> | ||
| </fileSet> | ||
| </fileSets> | ||
| </module> | ||
| <module id="${rootArtifactId}-deploy" dir="deploy" name="${rootArtifactId}-deploy"> | ||
| <fileSets> | ||
| <fileSet filtered="true" encoding="UTF-8"> | ||
| <directory/> | ||
| <includes> | ||
| <include>assembly-*.xml</include> | ||
| </includes> | ||
| </fileSet> | ||
| </fileSets> | ||
| </module> | ||
| <module id="${rootArtifactId}-web" dir="plugins/web" name="${rootArtifactId}-web"> | ||
| <fileSets> | ||
| <fileSet filtered="true" packaged="true" encoding="UTF-8"> | ||
| <directory>src/main/java</directory> | ||
| <includes> | ||
| <include>**/*.java</include> | ||
| </includes> | ||
| </fileSet> | ||
| <fileSet filtered="true" encoding="UTF-8"> | ||
| <directory>src/main/resources</directory> | ||
| <includes> | ||
| <include>**/*.properties</include> | ||
| <include>**/*.WebAppPlugin</include> | ||
| <include>**/*.css</include> | ||
| <include>**/*.hbs</include> | ||
| <include>**/*.js</include> | ||
| </includes> | ||
| </fileSet> | ||
| </fileSets> | ||
| </module> | ||
| <module id="${rootArtifactId}-worker" dir="plugins/worker" name="${rootArtifactId}-worker"> | ||
| <fileSets> | ||
| <fileSet filtered="true" packaged="true" encoding="UTF-8"> | ||
| <directory>src/main/java</directory> | ||
| <includes> | ||
| <include>**/*.java</include> | ||
| </includes> | ||
| </fileSet> | ||
| <fileSet filtered="true" encoding="UTF-8"> | ||
| <directory>src/main/resources</directory> | ||
| <includes> | ||
| <include>**/*.GraphPropertyWorker</include> | ||
| </includes> | ||
| </fileSet> | ||
| <fileSet filtered="true" packaged="true" encoding="UTF-8"> | ||
| <directory>src/test/java</directory> | ||
| <includes> | ||
| <include>**/*.java</include> | ||
| </includes> | ||
| </fileSet> | ||
| <fileSet encoding="UTF-8"> | ||
| <directory>src/test/resources</directory> | ||
| <includes> | ||
| <include>**/*.csv</include> | ||
| </includes> | ||
| </fileSet> | ||
| </fileSets> | ||
| </module> | ||
| </modules> | ||
| </archetype-descriptor> |
11 changes: 11 additions & 0 deletions
11
archetype/src/main/resources/META-INF/maven/org.visallo/visallo-plugin-archetype/pom.xml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <project xmlns="http://maven.apache.org/POM/4.0.0" | ||
| xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" | ||
| xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> | ||
| <modelVersion>4.0.0</modelVersion> | ||
|
|
||
| <groupId>org.visallo</groupId> | ||
| <artifactId>visallo-plugin-archetype</artifactId> | ||
| <version>2.2-SNAPSHOT</version> | ||
| <packaging>maven-archetype</packaging> | ||
| </project> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| ## Developing Your Own Plugins | ||
|
|
||
| From this point, you can develop your own plugins using the example project modules as templates. Consult the [tutorial section](http://docs.visallo.org/tutorials/) for further information. |
Oops, something went wrong.