Commits

David Carr committed 5d0c9c2

docs: improve javadoc for mac-provider

  • Participants
  • Parent commits 95c02bb

Comments (0)

Files changed (4)

File mac-provider/src/main/java/us/carrclan/david/authc4j/mac/provider/DefaultIdentityServicesUserInformationSource.java

 import us.carrclan.david.authc4j.mac.bindings.CSIdentityAuthorityRef;
 import us.carrclan.david.authc4j.mac.bindings.CoreServicesLibrary;
 
+/**
+ * A {@link us.carrclan.david.authc4j.api.UserInformationSource} implementation based on the default identity authority.
+ */
 public class DefaultIdentityServicesUserInformationSource extends IdentityServicesUserInformationSource {
     @Override
     CSIdentityAuthorityRef getIdentityAuthority() {

File mac-provider/src/main/java/us/carrclan/david/authc4j/mac/provider/LocalIdentityServicesUserInformationSource.java

 import us.carrclan.david.authc4j.mac.bindings.CSIdentityAuthorityRef;
 import us.carrclan.david.authc4j.mac.bindings.CoreServicesLibrary;
 
+/**
+ * A {@link us.carrclan.david.authc4j.api.UserInformationSource} implementation based on the local identity authority.
+ */
 public class LocalIdentityServicesUserInformationSource extends IdentityServicesUserInformationSource {
     @Override
     CSIdentityAuthorityRef getIdentityAuthority() {

File mac-provider/src/main/java/us/carrclan/david/authc4j/mac/provider/ManagedIdentityServicesUserInformationSource.java

 import us.carrclan.david.authc4j.mac.bindings.CSIdentityAuthorityRef;
 import us.carrclan.david.authc4j.mac.bindings.CoreServicesLibrary;
 
+/**
+ * A {@link us.carrclan.david.authc4j.api.UserInformationSource} implementation based on the managed identity authority.
+ */
 public class ManagedIdentityServicesUserInformationSource extends IdentityServicesUserInformationSource {
     @Override
     CSIdentityAuthorityRef getIdentityAuthority() {

File mac-provider/src/main/java/us/carrclan/david/authc4j/mac/provider/package-info.java

+/*
+ * Copyright 2013 David M. Carr
+ *
+ * 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.
+ */
+
+/**
+ * An AuthC4J provider backed by Mac OS X
+ * <a href="http://developer.apple.com/library/mac/documentation/Networking/Conceptual/IdentityServices_ProgGuide/Introduction/Introduction.html#//apple_ref/doc/uid/TP40004490">Identity Services</a>.
+ *
+ * <p>Identity Services provides access to three different "identity authorities": local, managed, and default.  The
+ * local identity authority contains only the identities stored on the local system.  The managed identity authority
+ * contains identities bound in network directory servers, such as a remote LDAP server.  The default identity
+ * authority acts as a union of the local and managed authorities.  Each of these authorities has a corresponding
+ * {@link us.carrclan.david.authc4j.api.UserInformationSource} implementation.</p>
+ */
+package us.carrclan.david.authc4j.mac.provider;