Skip to content
This repository was archived by the owner on Aug 23, 2023. It is now read-only.

Commit 5a62fc1

Browse files
alexkosowskialexkosowski
committed
Initial commit
1 parent cef55bd commit 5a62fc1

22 files changed

+886
-4
lines changed

‎.gitignore‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,3 +17,7 @@ target
1717

1818
# emacs
1919
*~
20+
21+
# netbeans
22+
nb-configuration.xml
23+
nbactions.xml

‎LICENSE.html‎

Lines changed: 174 additions & 0 deletions
Large diffs are not rendered by default.

‎README.adoc‎

Lines changed: 43 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,45 @@
1-
= JSR 375 Java EE Security Specification
1+
= JSR 375 EE Security API: Specification, Java API, and JavaDoc Generation
22

3-
This is the Specification source for JSR 375
3+
This project contains the AsciiDoc and Java API sources to generate the specification document, the Java API, and the JavaDoc. The project is organized into two modules: _api_ and _spec_. The api module contains the Java API sources, which may be used to generate the api jar and JavaDoc. The spec module contains the specification document sources, which may be used to generate the specification in both HTML and pdf format.
44

5-
- *primary*: git://java.net/javaee-security-spec~spec
6-
- mirror: [email protected]:javaee-security-spec/javaee-security-spec.git
5+
== Mirroring from java.net
6+
7+
The specification must originate from java.net per Oracle policy. To enable use of the facilities of GitHub, the java.net repository is periodically mirrored into a GitHub repository. The corresponding GitHub repository is effectively "read only".
8+
9+
Source Repository on java.net::
10+
`git://java.net/javaee-security-spec~spec-api`
11+
12+
Mirrored Respository on GitHub::
13+
`[email protected]:javaee-security-spec/spec-api.git`
14+
15+
== Generating the Specification, API, and JavaDoc
16+
17+
Just enter `mvn` at the command line. Maven will generate the following artifacts.
18+
19+
Specification as PDF::
20+
* The specification in PDF form.
21+
* In the directory: `spec/target/publish/docbook/publish/en-US/pdf`
22+
23+
Specification as HTML::
24+
* The specification in HTML form.
25+
* In the directory: `spec/target/publish/html`
26+
27+
API Jar::
28+
* The jar containing the api interfaces and classes.
29+
* In the directory: `/api/target`
30+
31+
API JavaDoc::
32+
* The JavaDoc for the api interfaces and classes.
33+
* In the directory: `api/target/site/apidocs`
34+
35+
== How to Contribute from GitHub
36+
37+
_NOTE: Only Expert Group members may contribute changes to this repository due to requiring a Java Specification Participation Agreement._
38+
39+
[start=1]
40+
. Fork the repository
41+
. Create the change in your fork
42+
. Submit a Pull Request
43+
. The change is reviewed
44+
. If approved, spec lead merges the change into java.net
45+
. Change gets mirrored back to GitHub

‎api/README.adoc‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
= JSR 375 EE Security API: Java API, and JavaDoc Generation
2+
3+
The api module contains the Java API sources to generate the Java API jar, and the JavaDoc.
4+
5+
== Generating the Java API and JavaDoc
6+
7+
Just enter `mvn` at the command line in this directory. Maven will generate the following artifacts.
8+
9+
API Jar::
10+
* The jar containing the api interfaces and classes
11+
* In the directory: `api/target`
12+
13+
API JavaDoc::
14+
* The JavaDoc for the api interfaces and classes
15+
* In the directory: `api/target/site/apidocs`
16+
* In the jar found in: `api/target`
17+
18+
== Java Source
19+
20+
API Source::
21+
* The source code for the api interfaces and classes
22+
* In the directory: `api/src/main/java`
23+
24+
Unit Test Source::
25+
* The source code for the API unit tests
26+
* In the directory: `api/src/test/java`
27+
28+
29+

‎api/pom.xml‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
<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/maven-v4_0_0.xsd">
2+
<modelVersion>4.0.0</modelVersion>
3+
4+
<parent>
5+
<groupId>javax.security</groupId>
6+
<artifactId>javax.security-spec</artifactId>
7+
<version>1.0</version>
8+
</parent>
9+
10+
<groupId>javax.security</groupId>
11+
<artifactId>javax.security-api</artifactId>
12+
<packaging>jar</packaging>
13+
14+
<name>EE Security API ${project.version}</name>
15+
<description>API for Java EE Security</description>
16+
17+
<build>
18+
<plugins>
19+
<plugin>
20+
<groupId>org.apache.maven.plugins</groupId>
21+
<artifactId>maven-compiler-plugin</artifactId>
22+
<version>3.2</version>
23+
<configuration>
24+
<source>1.8</source>
25+
<target>1.8</target>
26+
<useIncrementalCompilation>false</useIncrementalCompilation>
27+
<showWarnings>true</showWarnings>
28+
</configuration>
29+
</plugin>
30+
<plugin>
31+
<groupId>org.apache.maven.plugins</groupId>
32+
<artifactId>maven-javadoc-plugin</artifactId>
33+
<version>2.10.2</version>
34+
<executions>
35+
<execution>
36+
<id>attach-javadocs</id>
37+
<goals>
38+
<goal>jar</goal>
39+
</goals>
40+
</execution>
41+
</executions>
42+
<configuration>
43+
<doctitle>EE Security API ${project.version}</doctitle>
44+
<windowtitle>EE Security API ${project.version}</windowtitle>
45+
</configuration>
46+
</plugin>
47+
</plugins>
48+
</build>
49+
</project>

‎api/src/main/java/javax/security/Placeholder.java‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
/*
2+
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
3+
*
4+
* Copyright (c) 2015 Oracle and/or its affiliates. All rights reserved.
5+
*
6+
* The contents of this file are subject to the terms of either the GNU
7+
* General Public License Version 2 only ("GPL") or the Common Development
8+
* and Distribution License("CDDL") (collectively, the "License"). You
9+
* may not use this file except in compliance with the License. You can
10+
* obtain a copy of the License at
11+
* http://glassfish.java.net/public/CDDL+GPL_1_1.html
12+
* or packager/legal/LICENSE.txt. See the License for the specific
13+
* language governing permissions and limitations under the License.
14+
*
15+
* When distributing the software, include this License Header Notice in each
16+
* file and include the License file at packager/legal/LICENSE.txt.
17+
*
18+
* GPL Classpath Exception:
19+
* Oracle designates this particular file as subject to the "Classpath"
20+
* exception as provided by Oracle in the GPL Version 2 section of the License
21+
* file that accompanied this code.
22+
*
23+
* Modifications:
24+
* If applicable, add the following below the License Header, with the fields
25+
* enclosed by brackets [] replaced by your own identifying information:
26+
* "Portions Copyright [year] [name of copyright owner]"
27+
*
28+
* Contributor(s):
29+
* If you wish your version of this file to be governed by only the CDDL or
30+
* only the GPL Version 2, indicate your decision by adding "[Contributor]
31+
* elects to include this software in this distribution under the [CDDL or GPL
32+
* Version 2] license." If you don't indicate a single choice of license, a
33+
* recipient has the option to distribute your version of this file under
34+
* either the CDDL, the GPL Version 2 or to extend the choice of license to
35+
* its licensees as provided above. However, if you add GPL Version 2 code
36+
* and therefore, elected the GPL Version 2 license, then the option applies
37+
* only if the new code is made subject to such option by the copyright
38+
* holder.
39+
*/
40+
package javax.security;
41+
42+
/**
43+
* A placeholder class, to be removed once we get real classes..
44+
*/
45+
public class Placeholder {
46+
47+
/**
48+
* This class does something.
49+
*/
50+
public void doSomething() {
51+
52+
}
53+
54+
}

‎api/src/main/java/javax/security/package-info.java‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
/*
2+
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
3+
*
4+
* Copyright (c) 2015 Oracle and/or its affiliates. All rights reserved.
5+
*
6+
* The contents of this file are subject to the terms of either the GNU
7+
* General Public License Version 2 only ("GPL") or the Common Development
8+
* and Distribution License("CDDL") (collectively, the "License"). You
9+
* may not use this file except in compliance with the License. You can
10+
* obtain a copy of the License at
11+
* http://glassfish.java.net/public/CDDL+GPL_1_1.html
12+
* or packager/legal/LICENSE.txt. See the License for the specific
13+
* language governing permissions and limitations under the License.
14+
*
15+
* When distributing the software, include this License Header Notice in each
16+
* file and include the License file at packager/legal/LICENSE.txt.
17+
*
18+
* GPL Classpath Exception:
19+
* Oracle designates this particular file as subject to the "Classpath"
20+
* exception as provided by Oracle in the GPL Version 2 section of the License
21+
* file that accompanied this code.
22+
*
23+
* Modifications:
24+
* If applicable, add the following below the License Header, with the fields
25+
* enclosed by brackets [] replaced by your own identifying information:
26+
* "Portions Copyright [year] [name of copyright owner]"
27+
*
28+
* Contributor(s):
29+
* If you wish your version of this file to be governed by only the CDDL or
30+
* only the GPL Version 2, indicate your decision by adding "[Contributor]
31+
* elects to include this software in this distribution under the [CDDL or GPL
32+
* Version 2] license." If you don't indicate a single choice of license, a
33+
* recipient has the option to distribute your version of this file under
34+
* either the CDDL, the GPL Version 2 or to extend the choice of license to
35+
* its licensees as provided above. However, if you add GPL Version 2 code
36+
* and therefore, elected the GPL Version 2 license, then the option applies
37+
* only if the new code is made subject to such option by the copyright
38+
* holder.
39+
*/
40+
41+
/**
42+
* The root Security API package.
43+
*
44+
* @version 1.0
45+
*/
46+
package javax.security;
47+

‎api/src/main/javadoc/overview.html‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
<html>
2+
3+
<body>
4+
5+
<p>This is the EE Security API.</p>
6+
7+
</body>
8+
9+
</html>

‎pom.xml‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
2+
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
3+
<modelVersion>4.0.0</modelVersion>
4+
5+
<groupId>javax.security</groupId>
6+
<artifactId>javax.security-spec</artifactId>
7+
<version>1.0</version>
8+
<packaging>pom</packaging>
9+
10+
<name>EE Security API Specification</name>
11+
<description>Parent module for EE Security API Specification</description>
12+
13+
<url>https://java.net/projects/javaee-security-spec</url>
14+
<licenses>
15+
<license>
16+
<name>Java EE Security API 1.0 specification license</name>
17+
<url>https://jcp.org/aboutJava/communityprocess/licenses/jsr375/JSR_375-Spec-Java_EE_Security_API-1.0-11.25.14.pdf</url>
18+
</license>
19+
</licenses>
20+
21+
<organization>
22+
<name>Oracle Corporation</name>
23+
<url>http://www.oracle.com/</url>
24+
</organization>
25+
<issueManagement>
26+
<system>jira</system>
27+
<url>http://java.net/jira/browse/JAVAEE_SECURITY_SPEC</url>
28+
</issueManagement>
29+
<mailingLists>
30+
<mailingList>
31+
<name>JSR 375 Expert Group List</name>
32+
<archive>[email protected]</archive>
33+
</mailingList>
34+
<mailingList>
35+
<name>JSR 375 Specification Users List</name>
36+
<archive>[email protected]</archive>
37+
</mailingList>
38+
</mailingLists>
39+
40+
<modules>
41+
<module>spec</module>
42+
<module>api</module>
43+
</modules>
44+
45+
<build>
46+
<defaultGoal>clean package javadoc:javadoc</defaultGoal>
47+
</build>
48+
49+
</project>

‎spec/README.adoc‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
= JSR 375 EE Security API: Specification Generation
2+
3+
The spec module contains the AsciiDoc sources to generate the specification document in both HTML and pdf format.
4+
5+
== Generating the Specification
6+
7+
Just enter `mvn` at the command line in this directory. Maven will generate the following artifacts.
8+
9+
Specification as PDF::
10+
* The specification in PDF form.
11+
* In the directory: `spec/target/publish/docbook/publish/en-US/pdf`
12+
13+
Specification as HTML::
14+
* The specification in HTML form.
15+
* In the directory: `spec/target/publish/html`
16+
17+
== Specification Source
18+
19+
The AsciiDoc specification source is located in this directory:
20+
`spec/src/main/doc`
21+
22+
23+

0 commit comments

Comments
 (0)