Merge pull request #427 from pedroigor/ELY-484

[ELY-484] - Add JavaDoc for the 'org.wildfly.security.auth.realm' package and sub packages

src/main/java/org/wildfly/security/auth/realm/jdbc/mapper/package-info.java

@@ -0,0 +1,23 @@
+/*
+ * JBoss, Home of Professional Open Source.
+ * Copyright 2016 Red Hat, Inc., and individual contributors
+ * as indicated by the @author tags.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * Classes related to mapping columns from a database table to internal representations of identity data (eg.: attributes, password and keys, etc).
+ * See the {@link org.wildfly.security.auth.realm.jdbc.ColumnMapper} for the contract of column mappers.
+ */
+package org.wildfly.security.auth.realm.jdbc.mapper;

src/main/java/org/wildfly/security/auth/realm/jdbc/package-info.java

@@ -0,0 +1,22 @@
+/*
+ * JBoss, Home of Professional Open Source.
+ * Copyright 2016 Red Hat, Inc., and individual contributors
+ * as indicated by the @author tags.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * Classes related to a {@link org.wildfly.security.auth.server.SecurityRealm} implementation based on the JDBC (Java Database Connectivity) API.
+ */
+package org.wildfly.security.auth.realm.jdbc;

src/main/java/org/wildfly/security/auth/realm/ldap/package-info.java

@@ -17,6 +17,7 @@
  */
 
 /**
- * Classes pertaining to building and using LDAP security realms.
+ * Classes related to a {@link org.wildfly.security.auth.server.SecurityRealm} implementation capable of integrating with
+ * LDAP servers.
  */
 package org.wildfly.security.auth.realm.ldap;

src/main/java/org/wildfly/security/auth/realm/oauth2/package-info.java

@@ -0,0 +1,23 @@
+/*
+ * JBoss, Home of Professional Open Source.
+ * Copyright 2016 Red Hat, Inc., and individual contributors
+ * as indicated by the @author tags.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * Classes related to a {@link org.wildfly.security.auth.server.SecurityRealm} implementation capable of integrating with
+ * OAuth2-based Identity Providers in order to validate and build identities from security tokens.
+ */
+package org.wildfly.security.auth.realm.oauth2;