diff --git a/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/client/ClientConnection.java b/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/client/ClientConnection.java index bc76b51beb5..6c005f1079a 100644 --- a/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/client/ClientConnection.java +++ b/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/client/ClientConnection.java @@ -18,6 +18,7 @@ * David McKnight (IBM) [220123][dstore] Configurable timeout on irresponsiveness * David McKnight (IBM) - [220892][dstore] Backward compatibility: Server and Daemon should support old clients * David McKnight (IBM) - [225507][api][breaking] RSE dstore API leaks non-API types + * David McKnight (IBM) - [226561] [apidoc] Add API markup to RSE Javadocs where extend / implement is allowed *******************************************************************************/ package org.eclipse.dstore.core.client; @@ -81,6 +82,9 @@ import org.eclipse.dstore.internal.extra.DomainNotifier; * newly launched DataStore. Otherwise, a DataStore is expected to be running on * the remote machine under the same port that the client tries to connect to. * + * + * @noextend This class is not intended to be subclassed by clients. + * */ public class ClientConnection { @@ -111,12 +115,12 @@ public class ClientConnection private ArrayList _loaders; - public static String INCOMPATIBLE_SERVER_UPDATE = "Incompatible DataStore."; //$NON-NLS-1$ - public static String INCOMPATIBLE_CLIENT_UPDATE = "Incompatible DataStore."; //$NON-NLS-1$ - public static String SERVER_OLDER = "Older DataStore Server."; //$NON-NLS-1$ - public static String CLIENT_OLDER = "Older DataStore Client."; //$NON-NLS-1$ - public static String INCOMPATIBLE_PROTOCOL = "Incompatible Protocol."; //$NON-NLS-1$ - public static String CANNOT_CONNECT = "Cannot connect to server."; //$NON-NLS-1$ + public final static String INCOMPATIBLE_SERVER_UPDATE = "Incompatible DataStore."; //$NON-NLS-1$ + public final static String INCOMPATIBLE_CLIENT_UPDATE = "Incompatible DataStore."; //$NON-NLS-1$ + public final static String SERVER_OLDER = "Older DataStore Server."; //$NON-NLS-1$ + public final static String CLIENT_OLDER = "Older DataStore Client."; //$NON-NLS-1$ + public final static String INCOMPATIBLE_PROTOCOL = "Incompatible Protocol."; //$NON-NLS-1$ + public final static String CANNOT_CONNECT = "Cannot connect to server."; //$NON-NLS-1$ /** * Creates a new ClientConnection instance @@ -724,6 +728,7 @@ public class ClientConnection * * @param daemonPort the port of the daemon * @return the status of the connection + * @since 3.0 */ public ConnectionStatus connectDaemon(int daemonPort, int timeout) { ConnectionStatus result = new ConnectionStatus(true); diff --git a/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/client/ConnectionStatus.java b/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/client/ConnectionStatus.java index d0635c8d0d3..6316494fac9 100644 --- a/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/client/ConnectionStatus.java +++ b/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/client/ConnectionStatus.java @@ -11,7 +11,7 @@ * Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley. * * Contributors: - * {Name} (company) - description of contribution. + * David McKnight (IBM) - [226561] [apidoc] Add API markup to RSE Javadocs where extend / implement is allowed ********************************************************************************/ package org.eclipse.dstore.core.client; @@ -21,6 +21,9 @@ import java.util.List; /** * ConnectionStatus represents the state of a connection. This class is * used for feedback, when a client attempts to connect to a server. + * + * @noextend This class is not intended to be subclassed by clients. + * @noinstantiate This class is not intended to be instantiated by clients. */ public class ConnectionStatus { diff --git a/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/java/ClassByteStreamHandler.java b/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/java/ClassByteStreamHandler.java index 0d55a70c475..3c811eab3d3 100644 --- a/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/java/ClassByteStreamHandler.java +++ b/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/java/ClassByteStreamHandler.java @@ -1,5 +1,5 @@ /******************************************************************************** - * Copyright (c) 2005, 2006 IBM Corporation. All rights reserved. + * Copyright (c) 2005, 2008 IBM Corporation. All rights reserved. * This program and the accompanying materials are made available under the terms * of the Eclipse Public License v1.0 which accompanies this distribution, and is * available at http://www.eclipse.org/legal/epl-v10.html @@ -11,7 +11,7 @@ * Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley. * * Contributors: - * {Name} (company) - description of contribution. + * David McKnight (IBM) - [226561] [apidoc] Add API markup to RSE Javadocs where extend / implement is allowed ********************************************************************************/ package org.eclipse.dstore.core.java; @@ -36,7 +36,8 @@ import org.eclipse.dstore.core.model.DataStore; * If ClassByteStreamHandler is extended, you need to tell the DataStore to use the * extended implementation. To do that, call DataStore.setClassByteStreamHandler(ClassByteStreamHandler). *

- * + * @noextend This class is not intended to be subclassed by clients. + * @noinstantiate This class is not intended to be instantiated by clients. */ public class ClassByteStreamHandler implements IClassByteStreamHandler { diff --git a/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/java/ClassByteStreamHandlerRegistry.java b/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/java/ClassByteStreamHandlerRegistry.java index 7bef3a6f592..783be2ebb0f 100644 --- a/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/java/ClassByteStreamHandlerRegistry.java +++ b/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/java/ClassByteStreamHandlerRegistry.java @@ -1,5 +1,5 @@ /******************************************************************************** - * Copyright (c) 2006 IBM Corporation. All rights reserved. + * Copyright (c) 2008 IBM Corporation. All rights reserved. * This program and the accompanying materials are made available under the terms * of the Eclipse Public License v1.0 which accompanies this distribution, and is * available at http://www.eclipse.org/legal/epl-v10.html @@ -11,7 +11,7 @@ * Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley. * * Contributors: - * {Name} (company) - description of contribution. + * David McKnight (IBM) - [226561] [apidoc] Add API markup to RSE Javadocs where extend / implement is allowed ********************************************************************************/ package org.eclipse.dstore.core.java; @@ -20,7 +20,10 @@ import java.util.HashMap; import org.eclipse.dstore.core.model.DataStoreResources; - +/** + * @noextend This class is not intended to be subclassed by clients. + * @noinstantiate This class is not intended to be instantiated by clients. + */ public class ClassByteStreamHandlerRegistry { private HashMap _map; diff --git a/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/java/ClassInstanceOutputStream.java b/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/java/ClassInstanceOutputStream.java index e11a4c27c7f..e9d5109d41d 100644 --- a/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/java/ClassInstanceOutputStream.java +++ b/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/java/ClassInstanceOutputStream.java @@ -1,5 +1,5 @@ /******************************************************************************** - * Copyright (c) 2006 IBM Corporation. All rights reserved. + * Copyright (c) 2008 IBM Corporation. All rights reserved. * This program and the accompanying materials are made available under the terms * of the Eclipse Public License v1.0 which accompanies this distribution, and is * available at http://www.eclipse.org/legal/epl-v10.html @@ -11,7 +11,7 @@ * Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley. * * Contributors: - * {Name} (company) - description of contribution. + * David McKnight (IBM) - [226561] [apidoc] Add API markup to RSE Javadocs where extend / implement is allowed ********************************************************************************/ package org.eclipse.dstore.core.java; @@ -19,6 +19,10 @@ package org.eclipse.dstore.core.java; import java.io.IOException; import java.io.OutputStream; +/** + * @noextend This class is not intended to be subclassed by clients. + * @noinstantiate This class is not intended to be instantiated by clients. + */ public class ClassInstanceOutputStream extends OutputStream { public void write(int b) throws IOException { diff --git a/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/java/ClassRequest.java b/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/java/ClassRequest.java index 979358360e9..5bdb975e88f 100644 --- a/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/java/ClassRequest.java +++ b/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/java/ClassRequest.java @@ -1,5 +1,5 @@ /******************************************************************************** - * Copyright (c) 2006 IBM Corporation. All rights reserved. + * Copyright (c) 2008 IBM Corporation. All rights reserved. * This program and the accompanying materials are made available under the terms * of the Eclipse Public License v1.0 which accompanies this distribution, and is * available at http://www.eclipse.org/legal/epl-v10.html @@ -11,7 +11,7 @@ * Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley. * * Contributors: - * {Name} (company) - description of contribution. + * David McKnight (IBM) - [226561] [apidoc] Add API markup to RSE Javadocs where extend / implement is allowed ********************************************************************************/ package org.eclipse.dstore.core.java; @@ -22,6 +22,8 @@ package org.eclipse.dstore.core.java; * actual class after it has been loaded. * @author mjberger * + * @noextend This class is not intended to be subclassed by clients. + * @noinstantiate This class is not intended to be instantiated by clients. */ public class ClassRequest { diff --git a/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/java/IClassByteStreamHandler.java b/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/java/IClassByteStreamHandler.java index ec99d47133f..ec7a7565c55 100644 --- a/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/java/IClassByteStreamHandler.java +++ b/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/java/IClassByteStreamHandler.java @@ -1,5 +1,5 @@ /******************************************************************************** - * Copyright (c) 2003, 2006 IBM Corporation. All rights reserved. + * Copyright (c) 2003, 2008 IBM Corporation. All rights reserved. * This program and the accompanying materials are made available under the terms * of the Eclipse Public License v1.0 which accompanies this distribution, and is * available at http://www.eclipse.org/legal/epl-v10.html @@ -11,7 +11,7 @@ * Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley. * * Contributors: - * {Name} (company) - description of contribution. + * David McKnight (IBM) - [226561] [apidoc] Add API markup to RSE Javadocs where extend / implement is allowed ********************************************************************************/ package org.eclipse.dstore.core.java; @@ -21,6 +21,7 @@ package org.eclipse.dstore.core.java; * The IClassByteStreamHandler interface is used to abstract file read and write operations * across the network. * + * @noimplement This interface is not intended to be implemented by clients. */ public interface IClassByteStreamHandler { diff --git a/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/java/IRemoteClassInstance.java b/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/java/IRemoteClassInstance.java index faeb5e355e4..5faa0b1f0a9 100644 --- a/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/java/IRemoteClassInstance.java +++ b/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/java/IRemoteClassInstance.java @@ -1,5 +1,5 @@ /******************************************************************************** - * Copyright (c) 2006 IBM Corporation. All rights reserved. + * Copyright (c) 2008 IBM Corporation. All rights reserved. * This program and the accompanying materials are made available under the terms * of the Eclipse Public License v1.0 which accompanies this distribution, and is * available at http://www.eclipse.org/legal/epl-v10.html @@ -11,13 +11,16 @@ * Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley. * * Contributors: - * {Name} (company) - description of contribution. + * David McKnight (IBM) - [226561] [apidoc] Add API markup to RSE Javadocs where extend / implement is allowed ********************************************************************************/ package org.eclipse.dstore.core.java; import java.io.Serializable; +/** + * @noimplement This interface is not intended to be implemented by clients. + */ public interface IRemoteClassInstance extends Serializable { public void arrivedOnServer(); diff --git a/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/java/LocalObjectInputStream.java b/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/java/LocalObjectInputStream.java index fa7e71e7034..7992f98a12e 100644 --- a/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/java/LocalObjectInputStream.java +++ b/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/java/LocalObjectInputStream.java @@ -1,5 +1,5 @@ /******************************************************************************** - * Copyright (c) 2006 IBM Corporation. All rights reserved. + * Copyright (c) 2008 IBM Corporation. All rights reserved. * This program and the accompanying materials are made available under the terms * of the Eclipse Public License v1.0 which accompanies this distribution, and is * available at http://www.eclipse.org/legal/epl-v10.html @@ -11,7 +11,7 @@ * Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley. * * Contributors: - * {Name} (company) - description of contribution. + * David McKnight (IBM) - [226561] [apidoc] Add API markup to RSE Javadocs where extend / implement is allowed ********************************************************************************/ package org.eclipse.dstore.core.java; @@ -22,7 +22,10 @@ import java.io.ObjectInputStream; import java.io.ObjectStreamClass; import java.util.List; - +/** + * @noextend This class is not intended to be subclassed by clients. + * @noinstantiate This class is not intended to be instantiated by clients. + */ public class LocalObjectInputStream extends ObjectInputStream { private List _localLoaders; diff --git a/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/java/RemoteClassLoader.java b/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/java/RemoteClassLoader.java index 6806367dca6..e981ebef201 100644 --- a/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/java/RemoteClassLoader.java +++ b/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/java/RemoteClassLoader.java @@ -1,5 +1,5 @@ /******************************************************************************** - * Copyright (c) 2006 IBM Corporation. All rights reserved. + * Copyright (c) 2008 IBM Corporation. All rights reserved. * This program and the accompanying materials are made available under the terms * of the Eclipse Public License v1.0 which accompanies this distribution, and is * available at http://www.eclipse.org/legal/epl-v10.html @@ -11,7 +11,7 @@ * Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley. * * Contributors: - * {Name} (company) - description of contribution. + * David McKnight (IBM) - [226561] [apidoc] Add API markup to RSE Javadocs where extend / implement is allowed ********************************************************************************/ package org.eclipse.dstore.core.java; @@ -90,10 +90,12 @@ import org.eclipse.dstore.core.model.DataStore; * * @author mjberger * + * @noextend This class is not intended to be subclassed by clients. + * @noinstantiate This class is not intended to be instantiated by clients. */ public class RemoteClassLoader extends ClassLoader { - public static String CACHING_PREFERENCE = "Class.Caching"; //$NON-NLS-1$ + public final static String CACHING_PREFERENCE = "Class.Caching"; //$NON-NLS-1$ private DataStore _dataStore; private boolean _useCaching = false; private CacheClassLoader _urlClassLoader; diff --git a/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/java/RemoteObjectInputStream.java b/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/java/RemoteObjectInputStream.java index 6709e741781..700407de3ab 100644 --- a/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/java/RemoteObjectInputStream.java +++ b/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/java/RemoteObjectInputStream.java @@ -1,5 +1,5 @@ /******************************************************************************** - * Copyright (c) 2006 IBM Corporation. All rights reserved. + * Copyright (c) 2008 IBM Corporation. All rights reserved. * This program and the accompanying materials are made available under the terms * of the Eclipse Public License v1.0 which accompanies this distribution, and is * available at http://www.eclipse.org/legal/epl-v10.html @@ -11,7 +11,7 @@ * Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley. * * Contributors: - * {Name} (company) - description of contribution. + * David McKnight (IBM) - [226561] [apidoc] Add API markup to RSE Javadocs where extend / implement is allowed ********************************************************************************/ package org.eclipse.dstore.core.java; @@ -21,6 +21,10 @@ import java.io.InputStream; import java.io.ObjectInputStream; import java.io.ObjectStreamClass; +/** + * @noextend This class is not intended to be subclassed by clients. + * @noinstantiate This class is not intended to be instantiated by clients. + */ public class RemoteObjectInputStream extends ObjectInputStream { private RemoteClassLoader _loader; diff --git a/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/miners/Miner.java b/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/miners/Miner.java index 2aa35303bb0..897701389d8 100644 --- a/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/miners/Miner.java +++ b/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/miners/Miner.java @@ -15,6 +15,7 @@ * Noriaki Takatsu (IBM) [220126] [dstore][api][breaking] Single process server for multiple clients * David McKnight (IBM) [224906] [dstore] changes for getting properties and doing exit due to single-process capability * Noriaki Takatsu (IBM) [229146] [multithread] changes to stop Miner threads when clients disconnect + * David McKnight (IBM) - [226561] [apidoc] Add API markup to RSE Javadocs where extend / implement is allowed *******************************************************************************/ package org.eclipse.dstore.core.miners; @@ -38,6 +39,9 @@ import org.eclipse.dstore.core.server.SystemServiceManager; * The DataStore framework knows how to load and route commands to miners * because it interfaces miners through the restricted set of interfaces declared here. * To add a new miner, developers must extend this class and implement the abstract methods declared here. + * + * @noinstantiate This class is not intended to be instantiated by clients. The dstore server infrastructure + * will take care of loading the Miner. */ public abstract class Miner extends Handler implements ISchemaExtender diff --git a/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/model/ByteStreamHandlerRegistry.java b/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/model/ByteStreamHandlerRegistry.java index a424cf3f789..c01240d773b 100644 --- a/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/model/ByteStreamHandlerRegistry.java +++ b/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/model/ByteStreamHandlerRegistry.java @@ -1,5 +1,5 @@ /******************************************************************************** - * Copyright (c) 2006 IBM Corporation. All rights reserved. + * Copyright (c) 2008 IBM Corporation. All rights reserved. * This program and the accompanying materials are made available under the terms * of the Eclipse Public License v1.0 which accompanies this distribution, and is * available at http://www.eclipse.org/legal/epl-v10.html @@ -11,7 +11,7 @@ * Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley. * * Contributors: - * {Name} (company) - description of contribution. + * David McKnight (IBM) - [226561] [apidoc] Add API markup to RSE Javadocs where extend / implement is allowed ********************************************************************************/ package org.eclipse.dstore.core.model; @@ -24,6 +24,8 @@ import java.util.HashMap; * The appropriate byte stream handler is retrieved via the specified id. * If no such handler exists, then the default byte stream handler is returned. * + * @noextend This class is not intended to be subclassed by clients. + * @noinstantiate This class is not intended to be instantiated by clients. */ public class ByteStreamHandlerRegistry { diff --git a/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/model/Client.java b/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/model/Client.java index 26fe6452d95..7d4cdb94ea8 100644 --- a/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/model/Client.java +++ b/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/model/Client.java @@ -13,6 +13,7 @@ * Noriaki Takatsu (IBM) [220126] [dstore][api][breaking] Single process server for multiple clients * Jacob Garcowski (IBM) [225175] [dstore] [dstore] error handling change for Client * David McKnight (IBM) - [225507][api][breaking] RSE dstore API leaks non-API types + * David McKnight (IBM) - [226561] [apidoc] Add API markup to RSE Javadocs where extend / implement is allowed *******************************************************************************/ package org.eclipse.dstore.core.model; @@ -20,6 +21,9 @@ package org.eclipse.dstore.core.model; import org.eclipse.dstore.core.server.IServerLogger; import org.eclipse.dstore.core.server.ServerReceiver; +/** + * @noextend This class is not intended to be subclassed by clients. + */ public class Client { public String _userid; diff --git a/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/model/CommandHandler.java b/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/model/CommandHandler.java index 396e4b55247..c2cc6951afd 100644 --- a/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/model/CommandHandler.java +++ b/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/model/CommandHandler.java @@ -13,6 +13,7 @@ * * Contributors: * David McKnight (IBM) - [225507][api][breaking] RSE dstore API leaks non-API types + * David McKnight (IBM) - [226561] [apidoc] Add API markup to RSE Javadocs where extend / implement is allowed *******************************************************************************/ package org.eclipse.dstore.core.model; @@ -33,6 +34,9 @@ import org.eclipse.dstore.core.util.CommandGenerator; * The CommandHandler is the means by which the DataStore sends information or files from * the client to the remote tools. *

+ * + * @noextend This class is not intended to be subclassed by clients. + * @noinstantiate This class is not intended to be instantiated by clients. */ public abstract class CommandHandler extends Handler { diff --git a/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/model/DE.java b/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/model/DE.java index 73f3d773155..0c949628289 100644 --- a/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/model/DE.java +++ b/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/model/DE.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2001, 2007 IBM Corporation and others. + * Copyright (c) 2001, 2008 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at @@ -12,7 +12,7 @@ * Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley. * * Contributors: - * {Name} (company) - description of contribution. + * David McKnight (IBM) - [226561] [apidoc] Add API markup to RSE Javadocs where extend / implement is allowed *******************************************************************************/ package org.eclipse.dstore.core.model; @@ -31,6 +31,8 @@ package org.eclipse.dstore.core.model; * Attributes beginning with "A_" indicate DataElement indexs into attributes. * * + * @noextend This class is not intended to be subclassed by clients. + * @noinstantiate This class is not intended to be instantiated by clients. */ public class DE { diff --git a/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/model/DataElement.java b/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/model/DataElement.java index 59178442043..099c1c61810 100644 --- a/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/model/DataElement.java +++ b/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/model/DataElement.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2002, 2007 IBM Corporation and others. + * Copyright (c) 2002, 2008 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at @@ -12,7 +12,7 @@ * Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley. * * Contributors: - * {Name} (company) - description of contribution. + * David McKnight (IBM) - [226561] [apidoc] Add API markup to RSE Javadocs where extend / implement is allowed *******************************************************************************/ package org.eclipse.dstore.core.model; @@ -33,6 +33,9 @@ import org.eclipse.dstore.internal.extra.PropertySource; * DataElements should not be constructed directly, rather they are requested via the createObject() * method in DataStore * + * @noextend This class is not intended to be subclassed by clients. + * @noinstantiate This class is not intended to be instantiated by clients. DataElements + * should be created via the DataStore create methods. */ public final class DataElement implements IDataElement { diff --git a/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/model/DataStore.java b/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/model/DataStore.java index fbe73ebe065..f7b29773cab 100644 --- a/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/model/DataStore.java +++ b/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/model/DataStore.java @@ -22,6 +22,7 @@ * David McKnight (IBM) - [225507][api][breaking] RSE dstore API leaks non-API types * David McKnight (IBM) - [227881] [dstore][threaded] There is no chance to set client object for getUserPreferencesDirectory() * Norikai Takatsu (IBM) - [228156] [dstore] DataElementRemover thread doesn't terminate after a client disconnects the server + * David McKnight (IBM) - [226561] [apidoc] Add API markup to RSE Javadocs where extend / implement is allowed *******************************************************************************/ package org.eclipse.dstore.core.model; @@ -74,7 +75,8 @@ import org.eclipse.dstore.internal.core.util.XMLparser; * DataStore, either directly via a IDomainNotifier or indirectly over the communication * layer through a client DataStore. *

- * + * @noextend This class is not intended to be subclassed by clients. + * @noinstantiate This class is not intended to be instantiated by clients. */ public final class DataStore { @@ -2148,6 +2150,7 @@ public final class DataStore /** * Adds a preference change listener to the DataStore * @param listener + * @since 3.0 */ public void addDataStorePreferenceListener(IDataStorePreferenceListener listener){ _dataStorePreferenceListeners.add(listener); diff --git a/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/model/DataStoreAttributes.java b/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/model/DataStoreAttributes.java index e86452dd006..2a0fa21ab2e 100644 --- a/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/model/DataStoreAttributes.java +++ b/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/model/DataStoreAttributes.java @@ -14,6 +14,7 @@ * David McKnight (IBM) - update version to 9.0.0 * David McKnight (IBM) - [220892] version back to 8.1.0 since protocol hasn't changed * Martin Oberhuber (Wind River) - [cleanup] Add API "since" Javadoc tags + * David McKnight (IBM) - [226561] [apidoc] Add API markup to RSE Javadocs where extend / implement is allowed ********************************************************************************/ package org.eclipse.dstore.core.model; @@ -21,6 +22,9 @@ package org.eclipse.dstore.core.model; /** * This class is used to store attributes that are required for configuring a * remote connection. + * + * @noextend This class is not intended to be subclassed by clients. + * @noinstantiate This class is not intended to be instantiated by clients. */ public class DataStoreAttributes { diff --git a/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/model/DataStoreResources.java b/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/model/DataStoreResources.java index a15309e60fe..24ef0907081 100644 --- a/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/model/DataStoreResources.java +++ b/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/model/DataStoreResources.java @@ -1,5 +1,5 @@ /******************************************************************************** - * Copyright (c) 2006 IBM Corporation. All rights reserved. + * Copyright (c) 2008 IBM Corporation. All rights reserved. * This program and the accompanying materials are made available under the terms * of the Eclipse Public License v1.0 which accompanies this distribution, and is * available at http://www.eclipse.org/legal/epl-v10.html @@ -11,105 +11,109 @@ * Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley. * * Contributors: - * {Name} (company) - description of contribution. + * David McKnight (IBM) - [226561] [apidoc] Add API markup to RSE Javadocs where extend / implement is allowed ********************************************************************************/ package org.eclipse.dstore.core.model; +/** + * @noextend This class is not intended to be subclassed by clients. + * @noinstantiate This class is not intended to be instantiated by clients. + **/ public class DataStoreResources { - public static String model_Log_Root="Log Root"; //$NON-NLS-1$ - public static String model_Tool_Root="Tool Root"; //$NON-NLS-1$ - public static String model_Set="Set"; //$NON-NLS-1$ - public static String model_Modify="Modify"; //$NON-NLS-1$ - public static String model_timeout="timeout"; //$NON-NLS-1$ - public static String model_data="data"; //$NON-NLS-1$ - public static String model_transient="transient"; //$NON-NLS-1$ - public static String model_all="all"; //$NON-NLS-1$ - public static String model_host="host"; //$NON-NLS-1$ - public static String model_root="root"; //$NON-NLS-1$ - public static String model_descriptors="descriptors"; //$NON-NLS-1$ - public static String model_descriptor_for="descriptor for"; //$NON-NLS-1$ - public static String model_project="Project"; //$NON-NLS-1$ - public static String model_log="log"; //$NON-NLS-1$ - public static String model_deleted="deleted"; //$NON-NLS-1$ - public static String model_status="status"; //$NON-NLS-1$ - public static String model_start="start"; //$NON-NLS-1$ - public static String model_failed="failed"; //$NON-NLS-1$ - public static String model_done="done"; //$NON-NLS-1$ - public static String model_working="working"; //$NON-NLS-1$ - public static String model_progress="progress"; //$NON-NLS-1$ - public static String model_error="error"; //$NON-NLS-1$ - public static String model_warning="warning"; //$NON-NLS-1$ - public static String model_informational="informational"; //$NON-NLS-1$ - public static String model_markers="markers"; //$NON-NLS-1$ - public static String model_invocation="invocation"; //$NON-NLS-1$ - public static String model_pattern="pattern"; //$NON-NLS-1$ - public static String model_input="input"; //$NON-NLS-1$ - public static String model_output="output"; //$NON-NLS-1$ - public static String model_details="details"; //$NON-NLS-1$ - public static String model_contents="contents"; //$NON-NLS-1$ - public static String model_contents_arguments="Contents and Arguments"; //$NON-NLS-1$ - public static String model_parent="parent"; //$NON-NLS-1$ - public static String model_arguments="arguments"; //$NON-NLS-1$ - public static String model_Commands="Commands"; //$NON-NLS-1$ - public static String model_device="device"; //$NON-NLS-1$ - public static String model_directory="directory"; //$NON-NLS-1$ - public static String model_folder="folder"; //$NON-NLS-1$ - public static String model_file="file"; //$NON-NLS-1$ - public static String model_Filesystem_Objects="Filesystem Objects"; //$NON-NLS-1$ - public static String model_Container_Object="Container Object"; //$NON-NLS-1$ - public static String model_Directories="Directories"; //$NON-NLS-1$ - public static String model_Details="Details"; //$NON-NLS-1$ - public static String model_miners="miners"; //$NON-NLS-1$ - public static String model_miner="miner"; //$NON-NLS-1$ - public static String model_state="state"; //$NON-NLS-1$ - public static String model_ticket="ticket"; //$NON-NLS-1$ - public static String model_valid="valid"; //$NON-NLS-1$ - public static String model_invalid="invalid"; //$NON-NLS-1$ - public static String model_abstracted_by="abstracted by"; //$NON-NLS-1$ - public static String model_abstracts="abstracts"; //$NON-NLS-1$ - public static String model_incomplete="incomplete"; //$NON-NLS-1$ - public static String model_Miner_Details="Miner Details"; //$NON-NLS-1$ - public static String model_Hosts="Hosts"; //$NON-NLS-1$ - public static String model_Tools="Tools"; //$NON-NLS-1$ - public static String model_Schema="Schema"; //$NON-NLS-1$ - public static String model_Logged_Commands="Logged Commands"; //$NON-NLS-1$ - public static String model_Cancel="Cancel"; //$NON-NLS-1$ - public static String model_Get_Schema="Get Schema"; //$NON-NLS-1$ - public static String model_Show_Ticket="Show Ticket"; //$NON-NLS-1$ - public static String model_Init_Miners="Init Miners"; //$NON-NLS-1$ - public static String model_Set_Host="Set Host"; //$NON-NLS-1$ - public static String model_Exit="Exit"; //$NON-NLS-1$ - public static String model_Connect_to="Connect to"; //$NON-NLS-1$ - public static String model_Disconnect_from="Disconnect from"; //$NON-NLS-1$ - public static String model_Delete_Connection="Delete Connection"; //$NON-NLS-1$ - public static String model_time="time"; //$NON-NLS-1$ - public static String model_property="property"; //$NON-NLS-1$ - public static String model_start_time="start time"; //$NON-NLS-1$ - public static String model_command_time="command time"; //$NON-NLS-1$ - public static String model_Transient_Objects="Transient Objects"; //$NON-NLS-1$ - public static String model_Data="Data"; //$NON-NLS-1$ - public static String model_No_input="No input"; //$NON-NLS-1$ - public static String model_Open="Open"; //$NON-NLS-1$ - public static String model_Close="Close"; //$NON-NLS-1$ - public static String model_Refresh="Refresh"; //$NON-NLS-1$ - public static String model_Query="Query"; //$NON-NLS-1$ - public static String model_Cancellable="Cancellable"; //$NON-NLS-1$ + public static final String model_Log_Root="Log Root"; //$NON-NLS-1$ + public static final String model_Tool_Root="Tool Root"; //$NON-NLS-1$ + public static final String model_Set="Set"; //$NON-NLS-1$ + public static final String model_Modify="Modify"; //$NON-NLS-1$ + public static final String model_timeout="timeout"; //$NON-NLS-1$ + public static final String model_data="data"; //$NON-NLS-1$ + public static final String model_transient="transient"; //$NON-NLS-1$ + public static final String model_all="all"; //$NON-NLS-1$ + public static final String model_host="host"; //$NON-NLS-1$ + public static final String model_root="root"; //$NON-NLS-1$ + public static final String model_descriptors="descriptors"; //$NON-NLS-1$ + public static final String model_descriptor_for="descriptor for"; //$NON-NLS-1$ + public static final String model_project="Project"; //$NON-NLS-1$ + public static final String model_log="log"; //$NON-NLS-1$ + public static final String model_deleted="deleted"; //$NON-NLS-1$ + public static final String model_status="status"; //$NON-NLS-1$ + public static final String model_start="start"; //$NON-NLS-1$ + public static final String model_failed="failed"; //$NON-NLS-1$ + public static final String model_done="done"; //$NON-NLS-1$ + public static final String model_working="working"; //$NON-NLS-1$ + public static final String model_progress="progress"; //$NON-NLS-1$ + public static final String model_error="error"; //$NON-NLS-1$ + public static final String model_warning="warning"; //$NON-NLS-1$ + public static final String model_informational="informational"; //$NON-NLS-1$ + public static final String model_markers="markers"; //$NON-NLS-1$ + public static final String model_invocation="invocation"; //$NON-NLS-1$ + public static final String model_pattern="pattern"; //$NON-NLS-1$ + public static final String model_input="input"; //$NON-NLS-1$ + public static final String model_output="output"; //$NON-NLS-1$ + public static final String model_details="details"; //$NON-NLS-1$ + public static final String model_contents="contents"; //$NON-NLS-1$ + public static final String model_contents_arguments="Contents and Arguments"; //$NON-NLS-1$ + public static final String model_parent="parent"; //$NON-NLS-1$ + public static final String model_arguments="arguments"; //$NON-NLS-1$ + public static final String model_Commands="Commands"; //$NON-NLS-1$ + public static final String model_device="device"; //$NON-NLS-1$ + public static final String model_directory="directory"; //$NON-NLS-1$ + public static final String model_folder="folder"; //$NON-NLS-1$ + public static final String model_file="file"; //$NON-NLS-1$ + public static final String model_Filesystem_Objects="Filesystem Objects"; //$NON-NLS-1$ + public static final String model_Container_Object="Container Object"; //$NON-NLS-1$ + public static final String model_Directories="Directories"; //$NON-NLS-1$ + public static final String model_Details="Details"; //$NON-NLS-1$ + public static final String model_miners="miners"; //$NON-NLS-1$ + public static final String model_miner="miner"; //$NON-NLS-1$ + public static final String model_state="state"; //$NON-NLS-1$ + public static final String model_ticket="ticket"; //$NON-NLS-1$ + public static final String model_valid="valid"; //$NON-NLS-1$ + public static final String model_invalid="invalid"; //$NON-NLS-1$ + public static final String model_abstracted_by="abstracted by"; //$NON-NLS-1$ + public static final String model_abstracts="abstracts"; //$NON-NLS-1$ + public static final String model_incomplete="incomplete"; //$NON-NLS-1$ + public static final String model_Miner_Details="Miner Details"; //$NON-NLS-1$ + public static final String model_Hosts="Hosts"; //$NON-NLS-1$ + public static final String model_Tools="Tools"; //$NON-NLS-1$ + public static final String model_Schema="Schema"; //$NON-NLS-1$ + public static final String model_Logged_Commands="Logged Commands"; //$NON-NLS-1$ + public static final String model_Cancel="Cancel"; //$NON-NLS-1$ + public static final String model_Get_Schema="Get Schema"; //$NON-NLS-1$ + public static final String model_Show_Ticket="Show Ticket"; //$NON-NLS-1$ + public static final String model_Init_Miners="Init Miners"; //$NON-NLS-1$ + public static final String model_Set_Host="Set Host"; //$NON-NLS-1$ + public static final String model_Exit="Exit"; //$NON-NLS-1$ + public static final String model_Connect_to="Connect to"; //$NON-NLS-1$ + public static final String model_Disconnect_from="Disconnect from"; //$NON-NLS-1$ + public static final String model_Delete_Connection="Delete Connection"; //$NON-NLS-1$ + public static final String model_time="time"; //$NON-NLS-1$ + public static final String model_property="property"; //$NON-NLS-1$ + public static final String model_start_time="start time"; //$NON-NLS-1$ + public static final String model_command_time="command time"; //$NON-NLS-1$ + public static final String model_Transient_Objects="Transient Objects"; //$NON-NLS-1$ + public static final String model_Data="Data"; //$NON-NLS-1$ + public static final String model_No_input="No input"; //$NON-NLS-1$ + public static final String model_Open="Open"; //$NON-NLS-1$ + public static final String model_Close="Close"; //$NON-NLS-1$ + public static final String model_Refresh="Refresh"; //$NON-NLS-1$ + public static final String model_Query="Query"; //$NON-NLS-1$ + public static final String model_Cancellable="Cancellable"; //$NON-NLS-1$ - public static String SERIALIZED_TYPE="SERIALIZED"; //$NON-NLS-1$ - public static String CLASS_TYPE="CLASS"; //$NON-NLS-1$ - public static String REQUEST_CLASS_TYPE="REQUEST_CLASS"; //$NON-NLS-1$ - public static String DEFAULT_CLASSBYTESTREAMHANDLER="default"; //$NON-NLS-1$ - public static String FILE_TYPE="FILE"; //$NON-NLS-1$ - public static String DOCUMENT_TYPE="DOCUMENT"; //$NON-NLS-1$ - public static String DEFAULT_BYTESTREAMHANDLER="default"; //$NON-NLS-1$ - public static String TRUE="true"; //$NON-NLS-1$ - public static String FALSE="false"; //$NON-NLS-1$ - public static String DELETED="deleted"; //$NON-NLS-1$ - public static String KEEPALIVE_TYPE="KEEPALIVE"; //$NON-NLS-1$ - public static String KEEPALIVECONFIRM_TYPE="CONFIRMKEEPALIVE"; //$NON-NLS-1$ - public static String REFERENCE="reference"; //$NON-NLS-1$ - public static String VALUE="value"; //$NON-NLS-1$ - public static String SPIRIT="spirit"; //$NON-NLS-1$ + public static final String SERIALIZED_TYPE="SERIALIZED"; //$NON-NLS-1$ + public static final String CLASS_TYPE="CLASS"; //$NON-NLS-1$ + public static final String REQUEST_CLASS_TYPE="REQUEST_CLASS"; //$NON-NLS-1$ + public static final String DEFAULT_CLASSBYTESTREAMHANDLER="default"; //$NON-NLS-1$ + public static final String FILE_TYPE="FILE"; //$NON-NLS-1$ + public static final String DOCUMENT_TYPE="DOCUMENT"; //$NON-NLS-1$ + public static final String DEFAULT_BYTESTREAMHANDLER="default"; //$NON-NLS-1$ + public static final String TRUE="true"; //$NON-NLS-1$ + public static final String FALSE="false"; //$NON-NLS-1$ + public static final String DELETED="deleted"; //$NON-NLS-1$ + public static final String KEEPALIVE_TYPE="KEEPALIVE"; //$NON-NLS-1$ + public static final String KEEPALIVECONFIRM_TYPE="CONFIRMKEEPALIVE"; //$NON-NLS-1$ + public static final String REFERENCE="reference"; //$NON-NLS-1$ + public static final String VALUE="value"; //$NON-NLS-1$ + public static final String SPIRIT="spirit"; //$NON-NLS-1$ } diff --git a/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/model/DataStoreSchema.java b/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/model/DataStoreSchema.java index 2a221eea4a7..711aa463ed7 100644 --- a/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/model/DataStoreSchema.java +++ b/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/model/DataStoreSchema.java @@ -1,5 +1,5 @@ /******************************************************************************** - * Copyright (c) 2002, 2006 IBM Corporation. All rights reserved. + * Copyright (c) 2002, 2008 IBM Corporation. All rights reserved. * This program and the accompanying materials are made available under the terms * of the Eclipse Public License v1.0 which accompanies this distribution, and is * available at http://www.eclipse.org/legal/epl-v10.html @@ -11,7 +11,7 @@ * Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley. * * Contributors: - * {Name} (company) - description of contribution. + * David McKnight (IBM) - [226561] [apidoc] Add API markup to RSE Javadocs where extend / implement is allowed ********************************************************************************/ package org.eclipse.dstore.core.model; @@ -21,6 +21,9 @@ package org.eclipse.dstore.core.model; * This class is used for defining the base DataStore schema. All * miner schemas are derived from the schema defined here. This class * provides getters for quickly getting at commonly used schema descriptors. + * + * @noextend This class is not intended to be subclassed by clients. + * @noinstantiate This class is not intended to be instantiated by clients. */ public class DataStoreSchema { diff --git a/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/model/UpdateHandler.java b/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/model/UpdateHandler.java index 71035e3e27d..142809dda92 100644 --- a/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/model/UpdateHandler.java +++ b/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/model/UpdateHandler.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2002, 2007 IBM Corporation and others. + * Copyright (c) 2002, 2008 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at @@ -12,8 +12,8 @@ * Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley. * * Contributors: - * {Name} (company) - description of contribution. * David McKnight (IBM) [202822] should not be synchronizing on clean method + * David McKnight (IBM) - [226561] [apidoc] Add API markup to RSE Javadocs where extend / implement is allowed *******************************************************************************/ package org.eclipse.dstore.core.model; @@ -34,6 +34,9 @@ import org.eclipse.dstore.internal.core.util.DataElementRemover; *

* The UpdateHandler is the means by which the DataStore sends information or files from the remote tools to the client. *

+ * + * @noextend This class is not intended to be subclassed by clients. + * @noinstantiate This class is not intended to be instantiated by clients. */ public abstract class UpdateHandler extends Handler { diff --git a/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/server/ConnectionEstablisher.java b/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/server/ConnectionEstablisher.java index 6ad74676743..1b43e6ad022 100644 --- a/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/server/ConnectionEstablisher.java +++ b/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/server/ConnectionEstablisher.java @@ -20,6 +20,7 @@ * David McKnight (IBM) - [225507][api][breaking] RSE dstore API leaks non-API types * Noriaki Takatsu (IBM) - [226074] process for getStatus() API * Noriaki Takatsu (IBM) - [226237] [dstore] Move the place where the ServerLogger instance is made + * David McKnight (IBM) - [226561] [apidoc] Add API markup to RSE Javadocs where extend / implement is allowed *******************************************************************************/ package org.eclipse.dstore.core.server; @@ -39,12 +40,12 @@ import javax.net.ssl.SSLContext; import javax.net.ssl.SSLSession; import javax.net.ssl.SSLSocket; +import org.eclipse.dstore.core.model.Client; import org.eclipse.dstore.core.model.DE; import org.eclipse.dstore.core.model.DataElement; import org.eclipse.dstore.core.model.DataStore; import org.eclipse.dstore.core.model.DataStoreAttributes; import org.eclipse.dstore.core.model.ISSLProperties; -import org.eclipse.dstore.core.model.Client; import org.eclipse.dstore.internal.core.server.ServerAttributes; import org.eclipse.dstore.internal.core.server.ServerCommandHandler; import org.eclipse.dstore.internal.core.server.ServerReturnCodes; @@ -57,7 +58,9 @@ import org.eclipse.dstore.internal.core.util.ssl.DStoreSSLContext; /** * ConnectionEstablisher is responsible for managing the server DataStore and * facilitating the communication between client and server DataStores. - * + * + * @noextend This class is not intended to be subclassed by clients. + * @noinstantiate This class is not intended to be instantiated by clients. */ public class ConnectionEstablisher { diff --git a/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/server/Server.java b/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/server/Server.java index 51ad4aebe80..8fc029ee529 100644 --- a/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/server/Server.java +++ b/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/server/Server.java @@ -15,6 +15,7 @@ * Noriaki Takatsu (IBM) - [220126] [dstore][api][breaking] Single process server for multiple clients * David McKnight (IBM) [224906] [dstore] changes for getting properties and doing exit due to single-process capability * David McKnight (IBM) - [225507][api][breaking] RSE dstore API leaks non-API types + * David McKnight (IBM) - [226561] [apidoc] Add API markup to RSE Javadocs where extend / implement is allowed *******************************************************************************/ package org.eclipse.dstore.core.server; @@ -27,7 +28,8 @@ import org.eclipse.dstore.internal.core.server.ServerReturnCodes; * Server is the standard way of instantiating and controlling a remote DataStore. * The server runs a ConnectionEstablisher which manages client connections to * the DataStore. - * + * + * @noextend This class is not intended to be subclassed by clients. */ public class Server implements Runnable { diff --git a/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/server/ServerLauncher.java b/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/server/ServerLauncher.java index 6006ce4507d..b4b628e6227 100644 --- a/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/server/ServerLauncher.java +++ b/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/server/ServerLauncher.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2002, 2007 IBM Corporation and others. + * Copyright (c) 2002, 2008 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at @@ -13,6 +13,7 @@ * * Contributors: * David McKnight (IBM) - [193426] don't display exceptions + * David McKnight (IBM) - [226561] [apidoc] Add API markup to RSE Javadocs where extend / implement is allowed *******************************************************************************/ package org.eclipse.dstore.core.server; @@ -47,7 +48,8 @@ import org.eclipse.dstore.internal.core.util.ssl.DStoreSSLContext; /** * This class is the DataStore daemon. It is used for authenticating users, * launching DataStore servers under particular user IDs, and providing a client - * with enough information to conntect to a launched server. + * with enough information to connect to a launched server. + * */ public class ServerLauncher extends Thread { diff --git a/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/server/ServerReceiver.java b/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/server/ServerReceiver.java index ad5ad85877e..6c38221cfad 100644 --- a/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/server/ServerReceiver.java +++ b/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/server/ServerReceiver.java @@ -14,6 +14,7 @@ * Contributors: * David McKnight (IBM) - [225507][api][breaking] RSE dstore API leaks non-API types * Noriaki Takatsu (IBM) - [227905] prevent double invocations of finished in ConncetionEstablisher + * David McKnight (IBM) - [226561] [apidoc] Add API markup to RSE Javadocs where extend / implement is allowed *******************************************************************************/ package org.eclipse.dstore.core.server; @@ -26,6 +27,9 @@ import org.eclipse.dstore.core.util.Receiver; /** * The ServerReciever is responsible for recieving data from * the client side. + * + * @noextend This class is not intended to be subclassed by clients. + * @noinstantiate This class is not intended to be instantiated by clients. */ public class ServerReceiver extends Receiver { diff --git a/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/util/CommandGenerator.java b/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/util/CommandGenerator.java index 92a31192f0a..99687f661ba 100644 --- a/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/util/CommandGenerator.java +++ b/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/util/CommandGenerator.java @@ -13,6 +13,7 @@ * * Contributors: * David McKnight (IBM) - [225507][api][breaking] RSE dstore API leaks non-API types + * David McKnight (IBM) - [226561] [apidoc] Add API markup to RSE Javadocs where extend / implement is allowed *******************************************************************************/ package org.eclipse.dstore.core.util; @@ -29,6 +30,9 @@ import org.eclipse.dstore.core.model.DataStoreResources; * Command instances are instances of command descriptors. Each command instance contains a set of data arguments * and a status object, that represents the current state of a command. After a command instance is created, * it is referenced in the command log for the DataStore. + * + * @noextend This class is not intended to be subclassed by clients. + * @noinstantiate This class is not intended to be instantiated by clients. */ public class CommandGenerator { diff --git a/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/util/Receiver.java b/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/util/Receiver.java index 1be8e2bfb50..b799f76c922 100644 --- a/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/util/Receiver.java +++ b/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/util/Receiver.java @@ -16,6 +16,7 @@ * David McKnight (IBM) [222003] Client remains connected after server terminates * Noriaki Takatsu (IBM) - [220126] [dstore][api][breaking] Single process server for multiple clients * David McKnight (IBM) - [225507][api][breaking] RSE dstore API leaks non-API types + * David McKnight (IBM) - [226561] [apidoc] Add API markup to RSE Javadocs where extend / implement is allowed *******************************************************************************/ package org.eclipse.dstore.core.util; @@ -34,6 +35,9 @@ import org.eclipse.dstore.internal.core.util.XMLparser; /** * This class is used for receiving data from a socket in the DataStore * communication layer. + * + * @noextend This class is not intended to be subclassed by clients. + * @noinstantiate This class is not intended to be instantiated by clients. */ public abstract class Receiver extends SecuredThread implements IDataStorePreferenceListener { diff --git a/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/util/ssl/DStoreKeyStore.java b/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/util/ssl/DStoreKeyStore.java index 352a6f6c352..5c4ebddc9b5 100644 --- a/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/util/ssl/DStoreKeyStore.java +++ b/rse/plugins/org.eclipse.dstore.core/src/org/eclipse/dstore/core/util/ssl/DStoreKeyStore.java @@ -1,5 +1,5 @@ /******************************************************************************** - * Copyright (c) 2006 IBM Corporation. All rights reserved. + * Copyright (c) 2008 IBM Corporation. All rights reserved. * This program and the accompanying materials are made available under the terms * of the Eclipse Public License v1.0 which accompanies this distribution, and is * available at http://www.eclipse.org/legal/epl-v10.html @@ -11,7 +11,7 @@ * Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley. * * Contributors: - * {Name} (company) - description of contribution. + * David McKnight (IBM) - [226561] [apidoc] Add API markup to RSE Javadocs where extend / implement is allowed ********************************************************************************/ package org.eclipse.dstore.core.util.ssl; @@ -30,21 +30,23 @@ import java.security.cert.CertificateException; import java.security.cert.CertificateFactory; - +/** + * @noextend This class is not intended to be subclassed by clients. + * @noinstantiate This class is not intended to be instantiated by clients. + */ public class DStoreKeyStore { - public static DStoreKeyStore _instance = null; + private static DStoreKeyStore _instance = new DStoreKeyStore(); public DStoreKeyStore() { - _instance = this; } public static DStoreKeyStore getInstance() { if (_instance == null) { - new DStoreKeyStore(); + _instance = new DStoreKeyStore(); } return _instance; }