From 6a134916ca1ca990ca5e2f9f73e83162a48a9502 Mon Sep 17 00:00:00 2001 From: matthew_swift <matthew_swift@localhost> Date: Fri, 04 Dec 2009 18:05:31 +0000 Subject: [PATCH] Add stub package-info files. --- opendj-sdk/sdk/src/org/opends/sdk/controls/package-info.java | 31 +++++ opendj-sdk/sdk/src/org/opends/sdk/schema/package-info.java | 31 +++++ opendj-sdk/sdk/src/org/opends/sdk/tools/package-info.java | 31 +++++ opendj-sdk/sdk/src/org/opends/sdk/ldap/package-info.java | 32 +++++ opendj-sdk/sdk/src/org/opends/sdk/responses/package-info.java | 31 +++++ opendj-sdk/sdk/src/org/opends/sdk/ldif/package-info.java | 2 opendj-sdk/sdk/src/org/opends/sdk/sasl/package-info.java | 31 +++++ opendj-sdk/sdk/src/org/opends/sdk/package-info.java | 14 -- opendj-sdk/sdk/src/org/opends/sdk/requests/package-info.java | 31 +++++ opendj-sdk/sdk/src/org/opends/sdk/asn1/package-info.java | 36 ++++++ opendj-sdk/sdk/src/org/opends/sdk/extensions/package-info.java | 31 +++++ 11 files changed, 287 insertions(+), 14 deletions(-) diff --git a/opendj-sdk/sdk/src/org/opends/sdk/asn1/package-info.java b/opendj-sdk/sdk/src/org/opends/sdk/asn1/package-info.java new file mode 100755 index 0000000..5ab4bd7 --- /dev/null +++ b/opendj-sdk/sdk/src/org/opends/sdk/asn1/package-info.java @@ -0,0 +1,36 @@ +/* + * CDDL HEADER START + * + * The contents of this file are subject to the terms of the + * Common Development and Distribution License, Version 1.0 only + * (the "License"). You may not use this file except in compliance + * with the License. + * + * You can obtain a copy of the license at + * trunk/opends/resource/legal-notices/OpenDS.LICENSE + * or https://OpenDS.dev.java.net/OpenDS.LICENSE. + * See the License for the specific language governing permissions + * and limitations under the License. + * + * When distributing Covered Code, include this CDDL HEADER in each + * file and include the License file at + * trunk/opends/resource/legal-notices/OpenDS.LICENSE. If applicable, + * add the following below this CDDL HEADER, with the fields enclosed + * by brackets "[]" replaced with your own identifying information: + * Portions Copyright [yyyy] [name of copyright owner] + * + * CDDL HEADER END + * + * + * Copyright 2009 Sun Microsystems, Inc. + */ + +/** + * Classes and interfaces for encoding and decoding ASN.1 data streams. + * <p> + * Note that this particular implementation is limited to the subset of elements + * that are typically used by LDAP clients. As such, it does not include all + * ASN.1 element types, particularly elements like OIDs, bit strings, and + * timestamp values. + */ +package org.opends.sdk.asn1; diff --git a/opendj-sdk/sdk/src/org/opends/sdk/controls/package-info.java b/opendj-sdk/sdk/src/org/opends/sdk/controls/package-info.java new file mode 100755 index 0000000..92fe52a --- /dev/null +++ b/opendj-sdk/sdk/src/org/opends/sdk/controls/package-info.java @@ -0,0 +1,31 @@ +/* + * CDDL HEADER START + * + * The contents of this file are subject to the terms of the + * Common Development and Distribution License, Version 1.0 only + * (the "License"). You may not use this file except in compliance + * with the License. + * + * You can obtain a copy of the license at + * trunk/opends/resource/legal-notices/OpenDS.LICENSE + * or https://OpenDS.dev.java.net/OpenDS.LICENSE. + * See the License for the specific language governing permissions + * and limitations under the License. + * + * When distributing Covered Code, include this CDDL HEADER in each + * file and include the License file at + * trunk/opends/resource/legal-notices/OpenDS.LICENSE. If applicable, + * add the following below this CDDL HEADER, with the fields enclosed + * by brackets "[]" replaced with your own identifying information: + * Portions Copyright [yyyy] [name of copyright owner] + * + * CDDL HEADER END + * + * + * Copyright 2009 Sun Microsystems, Inc. + */ + +/** + * Classes implementing common LDAP controls. + */ +package org.opends.sdk.controls; diff --git a/opendj-sdk/sdk/src/org/opends/sdk/extensions/package-info.java b/opendj-sdk/sdk/src/org/opends/sdk/extensions/package-info.java new file mode 100755 index 0000000..bd698f1 --- /dev/null +++ b/opendj-sdk/sdk/src/org/opends/sdk/extensions/package-info.java @@ -0,0 +1,31 @@ +/* + * CDDL HEADER START + * + * The contents of this file are subject to the terms of the + * Common Development and Distribution License, Version 1.0 only + * (the "License"). You may not use this file except in compliance + * with the License. + * + * You can obtain a copy of the license at + * trunk/opends/resource/legal-notices/OpenDS.LICENSE + * or https://OpenDS.dev.java.net/OpenDS.LICENSE. + * See the License for the specific language governing permissions + * and limitations under the License. + * + * When distributing Covered Code, include this CDDL HEADER in each + * file and include the License file at + * trunk/opends/resource/legal-notices/OpenDS.LICENSE. If applicable, + * add the following below this CDDL HEADER, with the fields enclosed + * by brackets "[]" replaced with your own identifying information: + * Portions Copyright [yyyy] [name of copyright owner] + * + * CDDL HEADER END + * + * + * Copyright 2009 Sun Microsystems, Inc. + */ + +/** + * Classes implementing common LDAP extended operations. + */ +package org.opends.sdk.extensions; diff --git a/opendj-sdk/sdk/src/org/opends/sdk/ldap/package-info.java b/opendj-sdk/sdk/src/org/opends/sdk/ldap/package-info.java new file mode 100755 index 0000000..f39e868 --- /dev/null +++ b/opendj-sdk/sdk/src/org/opends/sdk/ldap/package-info.java @@ -0,0 +1,32 @@ +/* + * CDDL HEADER START + * + * The contents of this file are subject to the terms of the + * Common Development and Distribution License, Version 1.0 only + * (the "License"). You may not use this file except in compliance + * with the License. + * + * You can obtain a copy of the license at + * trunk/opends/resource/legal-notices/OpenDS.LICENSE + * or https://OpenDS.dev.java.net/OpenDS.LICENSE. + * See the License for the specific language governing permissions + * and limitations under the License. + * + * When distributing Covered Code, include this CDDL HEADER in each + * file and include the License file at + * trunk/opends/resource/legal-notices/OpenDS.LICENSE. If applicable, + * add the following below this CDDL HEADER, with the fields enclosed + * by brackets "[]" replaced with your own identifying information: + * Portions Copyright [yyyy] [name of copyright owner] + * + * CDDL HEADER END + * + * + * Copyright 2009 Sun Microsystems, Inc. + */ + +/** + * Classes and interfaces for interacting with a Directory Server + * using the LDAP protocol. + */ +package org.opends.sdk.ldap; diff --git a/opendj-sdk/sdk/src/org/opends/sdk/ldif/package-info.java b/opendj-sdk/sdk/src/org/opends/sdk/ldif/package-info.java index d471266..3353109 100755 --- a/opendj-sdk/sdk/src/org/opends/sdk/ldif/package-info.java +++ b/opendj-sdk/sdk/src/org/opends/sdk/ldif/package-info.java @@ -26,7 +26,7 @@ */ /** - * OpenDS LDIF support. + * Classes and interfaces for reading and writing LDIF. * * <h1>TO DO</h1> * <ul> diff --git a/opendj-sdk/sdk/src/org/opends/sdk/package-info.java b/opendj-sdk/sdk/src/org/opends/sdk/package-info.java index a7bc4bb..78eac13 100755 --- a/opendj-sdk/sdk/src/org/opends/sdk/package-info.java +++ b/opendj-sdk/sdk/src/org/opends/sdk/package-info.java @@ -26,7 +26,7 @@ */ /** - * OpenDS SDK. + * Core OpenDS SDK API including connections, entries, and attributes. * * <h1>TODO</h1> * <ul> @@ -44,32 +44,20 @@ * <li>rest of output must be in ASCII * </ul> * </ul> - * <li>Messages * <li>Logging? - * <li>Single entry search, blocking search <b>[Bo]</b> * <li>Exceptions sub-types for ErrorResultException (e.g. referrals, assertion failures, client side errors). - * <li>Refactor non-schema aware request / response APIs - how should they handle duplicate attribute descriptions and values? I.e. what matching should be performed: do they have List or Set semantics? [Matt] - * <ul> - * <li>AttributeValueSequence -> AttributeValueCollection? - * <li>AttributeSequence -> AttributeCollection? * <li>SearchResultEntry must be cheap to decode in non schema case. - * <li>Schema aware versions of these should provide set semantics w.r.t. attribute descriptions and attribute values. - * </ul> * <li>How should non-default Grizzly transport be specified by the application? * <li>Unmodifiable requests and responses * <li>Check that it is possible to create SearchResultEntry objects with empty attributes. * <li>Nameable? All objects that have a getName() method - * <li>DN, RDN - check APIs. <b>[Matt]</b> - * <li>Schema - clean up abstract stuff. Ensure exception handling is correct. <b>[Matt]</b> * <li>Enum / GeneralizedTime parsing function * <li>LDAP connection request timeouts configured using LDAPConnectionOptions. * <li>Re-instate Connection.isValid() * <li>Support parameters in result handlers. * <li>Javadoc * <li>Unit tests - * <li>Move to standalone source tree * <li>LDAP URL support and referral support - * <li>Thread safe DN caching * <li>Escapes in substring filter * <li>Threading model for decoding messages and calling result handlers * <li>SASL for CLI tools diff --git a/opendj-sdk/sdk/src/org/opends/sdk/requests/package-info.java b/opendj-sdk/sdk/src/org/opends/sdk/requests/package-info.java new file mode 100755 index 0000000..0e84921 --- /dev/null +++ b/opendj-sdk/sdk/src/org/opends/sdk/requests/package-info.java @@ -0,0 +1,31 @@ +/* + * CDDL HEADER START + * + * The contents of this file are subject to the terms of the + * Common Development and Distribution License, Version 1.0 only + * (the "License"). You may not use this file except in compliance + * with the License. + * + * You can obtain a copy of the license at + * trunk/opends/resource/legal-notices/OpenDS.LICENSE + * or https://OpenDS.dev.java.net/OpenDS.LICENSE. + * See the License for the specific language governing permissions + * and limitations under the License. + * + * When distributing Covered Code, include this CDDL HEADER in each + * file and include the License file at + * trunk/opends/resource/legal-notices/OpenDS.LICENSE. If applicable, + * add the following below this CDDL HEADER, with the fields enclosed + * by brackets "[]" replaced with your own identifying information: + * Portions Copyright [yyyy] [name of copyright owner] + * + * CDDL HEADER END + * + * + * Copyright 2009 Sun Microsystems, Inc. + */ + +/** + * Classes and interfaces for core LDAP requests. + */ +package org.opends.sdk.requests; diff --git a/opendj-sdk/sdk/src/org/opends/sdk/responses/package-info.java b/opendj-sdk/sdk/src/org/opends/sdk/responses/package-info.java new file mode 100755 index 0000000..e69befe --- /dev/null +++ b/opendj-sdk/sdk/src/org/opends/sdk/responses/package-info.java @@ -0,0 +1,31 @@ +/* + * CDDL HEADER START + * + * The contents of this file are subject to the terms of the + * Common Development and Distribution License, Version 1.0 only + * (the "License"). You may not use this file except in compliance + * with the License. + * + * You can obtain a copy of the license at + * trunk/opends/resource/legal-notices/OpenDS.LICENSE + * or https://OpenDS.dev.java.net/OpenDS.LICENSE. + * See the License for the specific language governing permissions + * and limitations under the License. + * + * When distributing Covered Code, include this CDDL HEADER in each + * file and include the License file at + * trunk/opends/resource/legal-notices/OpenDS.LICENSE. If applicable, + * add the following below this CDDL HEADER, with the fields enclosed + * by brackets "[]" replaced with your own identifying information: + * Portions Copyright [yyyy] [name of copyright owner] + * + * CDDL HEADER END + * + * + * Copyright 2009 Sun Microsystems, Inc. + */ + +/** + * Classes and interfaces for core LDAP responses. + */ +package org.opends.sdk.responses; diff --git a/opendj-sdk/sdk/src/org/opends/sdk/sasl/package-info.java b/opendj-sdk/sdk/src/org/opends/sdk/sasl/package-info.java new file mode 100755 index 0000000..6683fa9 --- /dev/null +++ b/opendj-sdk/sdk/src/org/opends/sdk/sasl/package-info.java @@ -0,0 +1,31 @@ +/* + * CDDL HEADER START + * + * The contents of this file are subject to the terms of the + * Common Development and Distribution License, Version 1.0 only + * (the "License"). You may not use this file except in compliance + * with the License. + * + * You can obtain a copy of the license at + * trunk/opends/resource/legal-notices/OpenDS.LICENSE + * or https://OpenDS.dev.java.net/OpenDS.LICENSE. + * See the License for the specific language governing permissions + * and limitations under the License. + * + * When distributing Covered Code, include this CDDL HEADER in each + * file and include the License file at + * trunk/opends/resource/legal-notices/OpenDS.LICENSE. If applicable, + * add the following below this CDDL HEADER, with the fields enclosed + * by brackets "[]" replaced with your own identifying information: + * Portions Copyright [yyyy] [name of copyright owner] + * + * CDDL HEADER END + * + * + * Copyright 2009 Sun Microsystems, Inc. + */ + +/** + * Classes and interfaces for common LDAP SASL Bind requests. + */ +package org.opends.sdk.sasl; diff --git a/opendj-sdk/sdk/src/org/opends/sdk/schema/package-info.java b/opendj-sdk/sdk/src/org/opends/sdk/schema/package-info.java new file mode 100755 index 0000000..ab62783 --- /dev/null +++ b/opendj-sdk/sdk/src/org/opends/sdk/schema/package-info.java @@ -0,0 +1,31 @@ +/* + * CDDL HEADER START + * + * The contents of this file are subject to the terms of the + * Common Development and Distribution License, Version 1.0 only + * (the "License"). You may not use this file except in compliance + * with the License. + * + * You can obtain a copy of the license at + * trunk/opends/resource/legal-notices/OpenDS.LICENSE + * or https://OpenDS.dev.java.net/OpenDS.LICENSE. + * See the License for the specific language governing permissions + * and limitations under the License. + * + * When distributing Covered Code, include this CDDL HEADER in each + * file and include the License file at + * trunk/opends/resource/legal-notices/OpenDS.LICENSE. If applicable, + * add the following below this CDDL HEADER, with the fields enclosed + * by brackets "[]" replaced with your own identifying information: + * Portions Copyright [yyyy] [name of copyright owner] + * + * CDDL HEADER END + * + * + * Copyright 2009 Sun Microsystems, Inc. + */ + +/** + * Classes and interfaces for constructing and querying LDAP schemas. + */ +package org.opends.sdk.schema; diff --git a/opendj-sdk/sdk/src/org/opends/sdk/tools/package-info.java b/opendj-sdk/sdk/src/org/opends/sdk/tools/package-info.java new file mode 100755 index 0000000..0715d9f --- /dev/null +++ b/opendj-sdk/sdk/src/org/opends/sdk/tools/package-info.java @@ -0,0 +1,31 @@ +/* + * CDDL HEADER START + * + * The contents of this file are subject to the terms of the + * Common Development and Distribution License, Version 1.0 only + * (the "License"). You may not use this file except in compliance + * with the License. + * + * You can obtain a copy of the license at + * trunk/opends/resource/legal-notices/OpenDS.LICENSE + * or https://OpenDS.dev.java.net/OpenDS.LICENSE. + * See the License for the specific language governing permissions + * and limitations under the License. + * + * When distributing Covered Code, include this CDDL HEADER in each + * file and include the License file at + * trunk/opends/resource/legal-notices/OpenDS.LICENSE. If applicable, + * add the following below this CDDL HEADER, with the fields enclosed + * by brackets "[]" replaced with your own identifying information: + * Portions Copyright [yyyy] [name of copyright owner] + * + * CDDL HEADER END + * + * + * Copyright 2009 Sun Microsystems, Inc. + */ + +/** + * Classes implementing the OpenDS SDK client tools. + */ +package org.opends.sdk.tools; -- Gitblit v1.10.0