diff options
author | slewis | 2015-09-15 16:56:59 +0000 |
---|---|---|
committer | slewis | 2015-09-15 16:56:59 +0000 |
commit | d3fbb5df4387ac6fa1d962e82f444db1bd926985 (patch) | |
tree | 4f0d798dca8032a107fff1e39980a6c0267fe856 | |
parent | bd5442d345ebd0ff898cc0ccd0b4ccd8b38923cb (diff) | |
download | org.eclipse.ecf-d3fbb5df4387ac6fa1d962e82f444db1bd926985.tar.gz org.eclipse.ecf-d3fbb5df4387ac6fa1d962e82f444db1bd926985.tar.xz org.eclipse.ecf-d3fbb5df4387ac6fa1d962e82f444db1bd926985.zip |
Documentation fixes
Change-Id: I98b60d692de0307220b1c8843f30b83a67536c28
5 files changed, 54 insertions, 54 deletions
diff --git a/osgi/bundles/org.eclipse.ecf.osgi.services.remoteserviceadmin/src/org/eclipse/ecf/osgi/services/remoteserviceadmin/IDiscoveredEndpointDescriptionFactory.java b/osgi/bundles/org.eclipse.ecf.osgi.services.remoteserviceadmin/src/org/eclipse/ecf/osgi/services/remoteserviceadmin/IDiscoveredEndpointDescriptionFactory.java index ab9b9e38c..b614a114e 100644 --- a/osgi/bundles/org.eclipse.ecf.osgi.services.remoteserviceadmin/src/org/eclipse/ecf/osgi/services/remoteserviceadmin/IDiscoveredEndpointDescriptionFactory.java +++ b/osgi/bundles/org.eclipse.ecf.osgi.services.remoteserviceadmin/src/org/eclipse/ecf/osgi/services/remoteserviceadmin/IDiscoveredEndpointDescriptionFactory.java @@ -78,7 +78,7 @@ public interface IDiscoveredEndpointDescriptionFactory { * @param locator * the locator responsible for the discoveredServiceInfo. Must * not be <code>null</code>. - * @param serviceId + * @param serviceID * the discovered service ID. Must not be <code>null</code>. * @return EndpointDescription that will be used to notify EndpointListeners * about an undiscovered EndpointDescription. If <code>null</code> diff --git a/osgi/bundles/org.eclipse.ecf.osgi.services.remoteserviceadmin/src/org/eclipse/ecf/osgi/services/remoteserviceadmin/IEndpointDescriptionLocator.java b/osgi/bundles/org.eclipse.ecf.osgi.services.remoteserviceadmin/src/org/eclipse/ecf/osgi/services/remoteserviceadmin/IEndpointDescriptionLocator.java index 68348c114..e7555b4d0 100644 --- a/osgi/bundles/org.eclipse.ecf.osgi.services.remoteserviceadmin/src/org/eclipse/ecf/osgi/services/remoteserviceadmin/IEndpointDescriptionLocator.java +++ b/osgi/bundles/org.eclipse.ecf.osgi.services.remoteserviceadmin/src/org/eclipse/ecf/osgi/services/remoteserviceadmin/IEndpointDescriptionLocator.java @@ -24,9 +24,11 @@ public interface IEndpointDescriptionLocator { EndpointDescription[] getDiscoveredEndpoints(); /** - * Get the service ID associated with the + * Get the service ID associated with the given endpoint description. + * * @param endpointDescription - * @return + * @return IServiceID associated discovered endpoint description. Will + * return <code>null</code> if no associated serviceID */ IServiceID getNetworkDiscoveredServiceID(EndpointDescription endpointDescription); diff --git a/osgi/bundles/org.eclipse.ecf.osgi.services.remoteserviceadmin/src/org/eclipse/ecf/osgi/services/remoteserviceadmin/IHostContainerSelector.java b/osgi/bundles/org.eclipse.ecf.osgi.services.remoteserviceadmin/src/org/eclipse/ecf/osgi/services/remoteserviceadmin/IHostContainerSelector.java index 44279122c..7f2d37fdc 100644 --- a/osgi/bundles/org.eclipse.ecf.osgi.services.remoteserviceadmin/src/org/eclipse/ecf/osgi/services/remoteserviceadmin/IHostContainerSelector.java +++ b/osgi/bundles/org.eclipse.ecf.osgi.services.remoteserviceadmin/src/org/eclipse/ecf/osgi/services/remoteserviceadmin/IHostContainerSelector.java @@ -21,8 +21,8 @@ import org.osgi.framework.ServiceReference; * {@link RemoteServiceAdmin#exportService(ServiceReference, java.util.Map)} ), * the RSA first gets an instance of this service via the service registry, and * then uses it to select an array of ECF host container instances by calling - * {@link #selectHostContainers(ServiceReference, String[], String[], String[])} - * . + * {@link #selectHostContainers(ServiceReference, Map<String,Object>, String[], + * String[], String[])} . * <p> * <p> * The {@link IRemoteServiceContainer} array returned is then used to actually diff --git a/osgi/bundles/org.eclipse.ecf.osgi.services.remoteserviceadmin/src/org/eclipse/ecf/osgi/services/remoteserviceadmin/IServiceInfoFactory.java b/osgi/bundles/org.eclipse.ecf.osgi.services.remoteserviceadmin/src/org/eclipse/ecf/osgi/services/remoteserviceadmin/IServiceInfoFactory.java index 104b8e795..3b04d004c 100644 --- a/osgi/bundles/org.eclipse.ecf.osgi.services.remoteserviceadmin/src/org/eclipse/ecf/osgi/services/remoteserviceadmin/IServiceInfoFactory.java +++ b/osgi/bundles/org.eclipse.ecf.osgi.services.remoteserviceadmin/src/org/eclipse/ecf/osgi/services/remoteserviceadmin/IServiceInfoFactory.java @@ -13,19 +13,16 @@ import org.eclipse.ecf.discovery.IDiscoveryAdvertiser; import org.eclipse.ecf.discovery.IServiceInfo; /** - * Service info factory service contract. A service info factory is used by the - * {@link EndpointDescriptionAdvertiser} to convert {@link EndpointDescription}s - * to {@link IServiceInfo} instances (via + * Service info factory service contract. A service info factory is used to + * convert {@link EndpointDescription}s to {@link IServiceInfo} instances (via * {@link #createServiceInfo(IDiscoveryAdvertiser, EndpointDescription)}. The - * resulting IServiceInfo instances are then used to by the - * {@link EndpointDescriptionAdvertiser} to publish the EndpointDescription - * metadata to a {@link IDiscoveryAdvertiser}. + * resulting IServiceInfo instances are then used to publish the + * EndpointDescription metadata to a {@link IDiscoveryAdvertiser}. * <p> * <p> * If no other instances of this service have been registered, a default - * instance of {@link ServiceInfoFactory} will be used by the - * {@link EndpointDescriptionAdvertiser}. Note that this default instance is - * registered with the lowest possible priority, so that if other + * instance of {@link ServiceInfoFactory} will be used. Note that this default + * instance is registered with the lowest possible priority, so that if other * {@link IServiceInfoFactory} instances are registered, they will be * preferred/used over the default. This means that Those wishing to * customize/control this process of converting {@link EndpointDescription}s to @@ -64,7 +61,6 @@ public interface IServiceInfoFactory { * <code>null</code> will be returned. * @since 3.0 */ - public IServiceInfo createServiceInfo( - IDiscoveryAdvertiser advertiser, + public IServiceInfo createServiceInfo(IDiscoveryAdvertiser advertiser, org.osgi.service.remoteserviceadmin.EndpointDescription endpointDescription); } diff --git a/osgi/bundles/org.eclipse.ecf.osgi.services.remoteserviceadmin/src/org/eclipse/ecf/osgi/services/remoteserviceadmin/RemoteConstants.java b/osgi/bundles/org.eclipse.ecf.osgi.services.remoteserviceadmin/src/org/eclipse/ecf/osgi/services/remoteserviceadmin/RemoteConstants.java index c4a04d38f..eddfcb713 100644 --- a/osgi/bundles/org.eclipse.ecf.osgi.services.remoteserviceadmin/src/org/eclipse/ecf/osgi/services/remoteserviceadmin/RemoteConstants.java +++ b/osgi/bundles/org.eclipse.ecf.osgi.services.remoteserviceadmin/src/org/eclipse/ecf/osgi/services/remoteserviceadmin/RemoteConstants.java @@ -19,11 +19,10 @@ import org.eclipse.ecf.remoteservice.IRemoteService; /** * ECF Remote Service Admin RemoteConstants. These are constants for ECF's RSA * implementation-specific meta-data. For OSGi Remote constant see - * {@link org.osgi.service.remoteserviceadmin.RemoteConstants} and the <a - * href="http://www.osgi.org/download/r4v42/r4.enterprise.pdf">OSGI 4.2 Remote - * Service Admin specification (chap 122)</a>. + * {@link org.osgi.service.remoteserviceadmin.RemoteConstants} and the + * <a href="http://www.osgi.org/download/r4v42/r4.enterprise.pdf">OSGI 4.2 + * Remote Service Admin specification (chap 122)</a>. * - * @noinstantiate This class is not intended to be instantiated by clients. * @noextend This class is not intended to be subclassed by clients. * @since 4.1 */ @@ -86,29 +85,32 @@ public final class RemoteConstants { */ public static final String DISCOVERY_DEFAULT_SERVICE_NAME_PREFIX = "osgirsvc_"; //$NON-NLS-1$ /** - * ECF {@link EndpointDescription} property (with value of type - * String) that defines the unique - * {@link org.eclipse.ecf.core.identity.Namespace} name. If present in the - * {@link EndpointDescription}, the value will be used to create the - * containerID for accessing a remote service. The Namespace name is - * optional because typically the ID protocol specifier (e.g. 'ecftcp' in ID - * with name: 'ecftcp://localhost:3282/server') can be used to unambiguously - * determine the appropriate {@link org.eclipse.ecf.core.identity.Namespace} - * used to create the container ID for remote service import. + * ECF {@link EndpointDescription} property (with value of type String) that + * defines the unique {@link org.eclipse.ecf.core.identity.Namespace} name. + * If present in the {@link EndpointDescription}, the value will be used to + * create the containerID for accessing a remote service. The Namespace name + * is optional because typically the ID protocol specifier (e.g. 'ecftcp' in + * ID with name: 'ecftcp://localhost:3282/server') can be used to + * unambiguously determine the appropriate + * {@link org.eclipse.ecf.core.identity.Namespace} used to create the + * container ID for remote service import. */ public static final String ENDPOINT_CONTAINER_ID_NAMESPACE = "ecf.endpoint.id.ns"; //$NON-NLS-1$ /** - * ECF {@link EndpointDescription} property (with value of type String) - * that defines the ecf endpoint id (typically the container id). + * ECF {@link EndpointDescription} property (with value of type String) that + * defines the ecf endpoint id (typically the container id). + * * @since 4.0 */ - public static final String ENDPOINT_ID = "ecf.endpoint.id"; //$NON-NLS-1$ + public static final String ENDPOINT_ID = "ecf.endpoint.id"; //$NON-NLS-1$ /** - * ECF {@link EndpointDescription} property (with value of type Long) - * that defines a service timestamp set upon initial export of the remote service. + * ECF {@link EndpointDescription} property (with value of type Long) that + * defines a service timestamp set upon initial export of the remote + * service. + * * @since 4.0 */ - public static final String ENDPOINT_TIMESTAMP = "ecf.endpoint.ts"; //$NON-NLS-1$ + public static final String ENDPOINT_TIMESTAMP = "ecf.endpoint.ts"; //$NON-NLS-1$ /** * Optional ECF {@link EndpointDescription} property (with value of type * String) that defines a connect target ID. If set/non-<code>null</code>, @@ -138,7 +140,7 @@ public final class RemoteConstants { * specified as a service property upon remote service registration, this * property allows ECF containers to be initialized and configured upon * creation during the call to - * {@link HostContainerSelector#selectHostContainers(org.osgi.framework.ServiceReference, String[], String[], String[])} + * {@link HostContainerSelector#selectHostContainers(org.osgi.framework.ServiceReference, Map, String[], String[], String[])} * . The type of the value may be String, ID, or Object[]. The * IContainerFactory.createContainer method is then selected based upon the * type of the value...i.e. @@ -154,7 +156,7 @@ public final class RemoteConstants { * as a service property for remote service export, this property allows ECF * containers to have given a connect context for authentication upon * container connection by - * {@link HostContainerSelector#selectHostContainers(org.osgi.framework.ServiceReference, String[], String[], String[])} + * {@link HostContainerSelector#selectHostContainers(org.osgi.framework.ServiceReference, Map, String[], String[], String[])} * . The type of the value is {@link IConnectContext}. */ public static final String SERVICE_EXPORTED_CONTAINER_CONNECT_CONTEXT = "ecf.exported.containerconnectcontext"; //$NON-NLS-1$ @@ -162,27 +164,28 @@ public final class RemoteConstants { * Container ID of the target host container for remote service export. If * specified as a service property for remote service export, this property * is used to match against the set of available containers in - * {@link HostContainerSelector#selectHostContainers(org.osgi.framework.ServiceReference, String[], String[], String[])} - * . The type of the value is {@link ID}. + * {@link HostContainerSelector#selectHostContainers(org.osgi.framework.ServiceReference, Map, String[], String[], String[])} + * . The type of the value is ID. */ public static final String SERVICE_EXPORTED_CONTAINER_ID = "ecf.exported.containerid"; //$NON-NLS-1$ /** - * Service property marking the service for async proxy export. It defines the - * async interfaces under which this service will be exported on the remote - * proxy. This list must be a - * subset of the types service was exported (i.e. subset of interfaces specified - * by #{@link org.osgi.service.remoteserviceadmin.RemoteConstants#SERVICE_EXPORTED_INTERFACES}. The single - * value of an asterisk ("*", \u002A) indicates all the - * interface types under which the service was exported. + * Service property marking the service for async proxy export. It defines + * the async interfaces under which this service will be exported on the + * remote proxy. This list must be a subset of the types service was + * exported (i.e. subset of interfaces specified by # + * {@link org.osgi.service.remoteserviceadmin.RemoteConstants#SERVICE_EXPORTED_INTERFACES} + * . The single value of an asterisk ("*", \u002A) indicates + * all the interface types under which the service was exported. * <p> - * The interfaces in the String[] can either be + * The interfaces in the String[] can either be * <ol> - * <li>The same fully qualified name as an interface - * in the #{@link org.osgi.service.remoteserviceadmin.RemoteConstants#SERVICE_EXPORTED_INTERFACES} property</li> - * <li>The fully qualified name of an interface that follows the asynchronous proxy conventions to - * match with one of the existing exported types. - * </li> + * <li>The same fully qualified name as an interface in the # + * {@link org.osgi.service.remoteserviceadmin.RemoteConstants#SERVICE_EXPORTED_INTERFACES} + * property</li> + * <li>The fully qualified name of an interface that follows the + * asynchronous proxy conventions to match with one of the existing exported + * types.</li> * * <p> * This property may be supplied in the {@code properties} @@ -235,6 +238,5 @@ public final class RemoteConstants { * @since 4.1 */ public static final String OSGI_CONTAINER_ID_NS = "ecf.osgi.ns"; //$NON-NLS-1$ - - + } |