diff options
author | slewis | 2016-03-12 01:50:15 +0000 |
---|---|---|
committer | slewis | 2016-03-12 01:50:15 +0000 |
commit | 37b90f840fbce66f3240b80698798885f6f162e2 (patch) | |
tree | 99593e7111a42e2911873cb5432c6ef7bd23c037 /osgi/bundles | |
parent | d5d525fe2b7a025097345d6c4199fa235dd20b78 (diff) | |
download | org.eclipse.ecf-37b90f840fbce66f3240b80698798885f6f162e2.tar.gz org.eclipse.ecf-37b90f840fbce66f3240b80698798885f6f162e2.tar.xz org.eclipse.ecf-37b90f840fbce66f3240b80698798885f6f162e2.zip |
Javadocs updates
Change-Id: I0f6ea74aa2c2402fa7f3f42c423e88ad84544c69
Diffstat (limited to 'osgi/bundles')
16 files changed, 167 insertions, 29 deletions
diff --git a/osgi/bundles/org.eclipse.ecf.osgi.services.remoteserviceadmin/src/org/eclipse/ecf/osgi/services/remoteserviceadmin/AbstractConsumerContainerSelector.java b/osgi/bundles/org.eclipse.ecf.osgi.services.remoteserviceadmin/src/org/eclipse/ecf/osgi/services/remoteserviceadmin/AbstractConsumerContainerSelector.java index e29d667c9..e141740da 100644 --- a/osgi/bundles/org.eclipse.ecf.osgi.services.remoteserviceadmin/src/org/eclipse/ecf/osgi/services/remoteserviceadmin/AbstractConsumerContainerSelector.java +++ b/osgi/bundles/org.eclipse.ecf.osgi.services.remoteserviceadmin/src/org/eclipse/ecf/osgi/services/remoteserviceadmin/AbstractConsumerContainerSelector.java @@ -184,6 +184,11 @@ public class AbstractConsumerContainerSelector extends } /** + * @param containerTypeDescription containerTypeDescription + * @param containerTypeDescriptionName containerTypeDescriptionName + * @param properties properties + * @return IRemoteServiceContainer created container. Should not be <code>null</code> + * @throws SelectContainerException thrown if container cannot be created or configured * @since 2.0 */ protected IRemoteServiceContainer createContainer( diff --git a/osgi/bundles/org.eclipse.ecf.osgi.services.remoteserviceadmin/src/org/eclipse/ecf/osgi/services/remoteserviceadmin/AbstractContainerSelector.java b/osgi/bundles/org.eclipse.ecf.osgi.services.remoteserviceadmin/src/org/eclipse/ecf/osgi/services/remoteserviceadmin/AbstractContainerSelector.java index 9fcb494af..59916440b 100644 --- a/osgi/bundles/org.eclipse.ecf.osgi.services.remoteserviceadmin/src/org/eclipse/ecf/osgi/services/remoteserviceadmin/AbstractContainerSelector.java +++ b/osgi/bundles/org.eclipse.ecf.osgi.services.remoteserviceadmin/src/org/eclipse/ecf/osgi/services/remoteserviceadmin/AbstractContainerSelector.java @@ -118,6 +118,11 @@ public abstract class AbstractContainerSelector { } /** + * @param serviceReference serviceReference + * @param properties overriding properties + * @param containerTypeDescription containerTypeDescription + * @return IContainer created container. Should not be <code>null</code> + * @throws SelectContainerException thrown if some create or configure failure * @since 2.0 */ protected IContainer createContainer(ServiceReference serviceReference, @@ -157,6 +162,10 @@ public abstract class AbstractContainerSelector { } /** + * @param serviceReference serviceReference + * @param properties overriding properties + * @param containerTypeDescription containerTypeDescription + * @return Object container factory arguments to use * @since 2.0 */ protected Object getContainerFactoryArguments( @@ -187,6 +196,11 @@ public abstract class AbstractContainerSelector { } /** + * @param serviceReference serviceReference + * @param properties overriding properties + * @param container the container to create connect context for + * @param context a possible connect context] + * @return IConnectContext a connect context or null * @since 2.0 */ protected IConnectContext createConnectContext( diff --git a/osgi/bundles/org.eclipse.ecf.osgi.services.remoteserviceadmin/src/org/eclipse/ecf/osgi/services/remoteserviceadmin/AbstractHostContainerSelector.java b/osgi/bundles/org.eclipse.ecf.osgi.services.remoteserviceadmin/src/org/eclipse/ecf/osgi/services/remoteserviceadmin/AbstractHostContainerSelector.java index a42001549..147799352 100644 --- a/osgi/bundles/org.eclipse.ecf.osgi.services.remoteserviceadmin/src/org/eclipse/ecf/osgi/services/remoteserviceadmin/AbstractHostContainerSelector.java +++ b/osgi/bundles/org.eclipse.ecf.osgi.services.remoteserviceadmin/src/org/eclipse/ecf/osgi/services/remoteserviceadmin/AbstractHostContainerSelector.java @@ -18,7 +18,6 @@ import java.util.List; import java.util.Map; import org.eclipse.ecf.core.ContainerConnectException; -import org.eclipse.ecf.core.ContainerCreateException; import org.eclipse.ecf.core.ContainerTypeDescription; import org.eclipse.ecf.core.IContainer; import org.eclipse.ecf.core.identity.ID; @@ -46,6 +45,12 @@ public abstract class AbstractHostContainerSelector extends } /** + * @param serviceReference service reference + * @param overridingProperties overriding properties + * @param serviceExportedInterfaces service exported interfaces to select for + * @param serviceExportedConfigs service exported configs to select for + * @param serviceIntents service exported intents to select for + * @return Collection of existing host containers * @since 2.0 */ protected Collection selectExistingHostContainers( @@ -104,6 +109,10 @@ public abstract class AbstractHostContainerSelector extends } /** + * @param serviceReference serviceReference + * @param properties properties + * @param container container to match + * @return boolean true if match false otherwise * @since 2.0 */ protected boolean matchHostContainerToConnectTarget( @@ -141,6 +150,14 @@ public abstract class AbstractHostContainerSelector extends } /** + * @param serviceReference service reference + * @param properties properties + * @param container container + * @param adapter remote service container adapter + * @param description container type description + * @param requiredConfigTypes required config types + * @param requiredServiceIntents required service intents + * @return boolean true if match, false otherwise * @since 2.0 */ protected boolean matchExistingHostContainer( @@ -158,6 +175,10 @@ public abstract class AbstractHostContainerSelector extends } /** + * @param serviceReference serviceReference + * @param properties properties + * @param container container + * @return boolean true if match, false otherwise * @since 2.0 */ protected boolean matchHostContainerID(ServiceReference serviceReference, @@ -198,6 +219,11 @@ public abstract class AbstractHostContainerSelector extends return containerID.equals(cID); } + /** + * @param requiredConfigTypes request config types + * @param containerTypeDescription container type description + * @return boolean true if match, false otherwise + */ protected boolean matchHostSupportedConfigTypes( String[] requiredConfigTypes, ContainerTypeDescription containerTypeDescription) { @@ -222,6 +248,13 @@ public abstract class AbstractHostContainerSelector extends } /** + * @param serviceReference service reference + * @param properties overriding properties + * @param serviceExportedInterfaces service exported interfaces to select for + * @param requiredConfigs service exported configs to select for + * @param requiredIntents intents to select for + * @return Collection of host containers + * @throws SelectContainerException if container cannot be created or configured * @since 2.0 */ protected Collection createAndConfigureHostContainers( @@ -303,7 +336,14 @@ public abstract class AbstractHostContainerSelector extends } /** - * @throws ContainerCreateException + * @param containerTypeDescription containerTypeDescription + * @param serviceReference reference + * @param properties properties + * @param serviceExportedInterfaces exported interfaces + * @param requiredConfigs configs + * @param requiredIntents intents + * @return IRemoteServiceContainer matching container created + * @throws SelectContainerException container cannot be created or selected * @since 2.0 */ protected IRemoteServiceContainer createMatchingContainer( @@ -323,7 +363,11 @@ public abstract class AbstractHostContainerSelector extends } /** - * @throws ContainerCreateException + * @param serviceReference serviceReference + * @param properties properties + * @param containerTypeDescription container type description + * @return IRemoteServiceContainer created remote service container + * @throws SelectContainerException if could not be created * @since 2.0 */ protected IRemoteServiceContainer createRSContainer( @@ -341,6 +385,12 @@ public abstract class AbstractHostContainerSelector extends } /** + * @param serviceReference service reference + * @param properties properties + * @param container container + * @param target target + * @throws ContainerConnectException if container cannot be connected + * @throws IDCreateException thrown if ID cannot be created * @since 2.0 */ protected void connectHostContainer(ServiceReference serviceReference, diff --git a/osgi/bundles/org.eclipse.ecf.osgi.services.remoteserviceadmin/src/org/eclipse/ecf/osgi/services/remoteserviceadmin/AbstractMetadataFactory.java b/osgi/bundles/org.eclipse.ecf.osgi.services.remoteserviceadmin/src/org/eclipse/ecf/osgi/services/remoteserviceadmin/AbstractMetadataFactory.java index f0162985b..76a8f5942 100644 --- a/osgi/bundles/org.eclipse.ecf.osgi.services.remoteserviceadmin/src/org/eclipse/ecf/osgi/services/remoteserviceadmin/AbstractMetadataFactory.java +++ b/osgi/bundles/org.eclipse.ecf.osgi.services.remoteserviceadmin/src/org/eclipse/ecf/osgi/services/remoteserviceadmin/AbstractMetadataFactory.java @@ -175,6 +175,9 @@ public abstract class AbstractMetadataFactory { } /** + * @param discoveredServiceProperties discovered service properties + * @return org.osgi.service.remoteserviceadmin.EndpointDescription endpoint description decoded from service p + * properties * @since 3.0 */ protected org.osgi.service.remoteserviceadmin.EndpointDescription decodeEndpointDescription( @@ -273,6 +276,8 @@ public abstract class AbstractMetadataFactory { } /** + * @param endpointDescription endpoint description to encode + * @param result service properties to add encoded endpoint description properties to * @since 3.0 */ protected void encodeOSGiServiceProperties( @@ -360,6 +365,9 @@ public abstract class AbstractMetadataFactory { } /** + * @param endpointDescription endpoint description to encode + * @param result service properties to add encoded endpoint description properties to + * * @since 3.0 */ protected void encodeServiceProperties( diff --git a/osgi/bundles/org.eclipse.ecf.osgi.services.remoteserviceadmin/src/org/eclipse/ecf/osgi/services/remoteserviceadmin/AbstractTopologyManager.java b/osgi/bundles/org.eclipse.ecf.osgi.services.remoteserviceadmin/src/org/eclipse/ecf/osgi/services/remoteserviceadmin/AbstractTopologyManager.java index 69c8b103a..a54e21dfd 100644 --- a/osgi/bundles/org.eclipse.ecf.osgi.services.remoteserviceadmin/src/org/eclipse/ecf/osgi/services/remoteserviceadmin/AbstractTopologyManager.java +++ b/osgi/bundles/org.eclipse.ecf.osgi.services.remoteserviceadmin/src/org/eclipse/ecf/osgi/services/remoteserviceadmin/AbstractTopologyManager.java @@ -130,6 +130,8 @@ public abstract class AbstractTopologyManager { } /** + * @param ctx the bundle context + * @return Filter the created filter * @since 4.0 */ protected Filter createISIFFilter(BundleContext ctx) { @@ -168,6 +170,7 @@ public abstract class AbstractTopologyManager { } /** + * @param endpointDescription endpoint description * @since 4.1 */ protected void advertiseModifyEndpointDescription( @@ -204,6 +207,7 @@ public abstract class AbstractTopologyManager { } /** + * @param endpointDescription endpoint description * @since 3.0 */ protected void advertiseEndpointDescription( @@ -243,6 +247,7 @@ public abstract class AbstractTopologyManager { } /** + * @param endpointDescription endpoint description * @since 3.0 */ protected void unadvertiseEndpointDescription( @@ -283,6 +288,7 @@ public abstract class AbstractTopologyManager { } /** + * @param endpointDescription endpoint description * @since 3.0 */ protected void handleECFEndpointAdded( @@ -296,6 +302,7 @@ public abstract class AbstractTopologyManager { } /** + * @param endpointDescription endpoint description * @since 3.0 */ protected void handleECFEndpointRemoved( @@ -317,6 +324,7 @@ public abstract class AbstractTopologyManager { } /** + * @param endpoint endpoint description * @since 4.1 */ protected void handleECFEndpointModified(EndpointDescription endpoint) { @@ -337,6 +345,8 @@ public abstract class AbstractTopologyManager { } /** + * @param listener listener + * @param endpointDescription endpoint description * @since 3.0 */ protected void handleNonECFEndpointAdded( @@ -346,6 +356,8 @@ public abstract class AbstractTopologyManager { } /** + * @param listener listener + * @param endpointDescription endpoint description * @since 3.0 */ protected void handleNonECFEndpointRemoved( @@ -355,6 +367,8 @@ public abstract class AbstractTopologyManager { } /** + * @param basicTopologyManagerImpl basic topology manager + * @param endpointDescription endpointDescription * @since 4.1 */ protected void handleNonECFEndpointModified( @@ -364,6 +378,8 @@ public abstract class AbstractTopologyManager { } /** + * @param endpointDescription endpoint description + * @param matchedFilter matched filter * @since 3.0 */ protected void handleNonECFEndpointRemoved( @@ -373,6 +389,9 @@ public abstract class AbstractTopologyManager { } /** + * @param result result + * @param endpointDescription endpoint description + * @param advertise advertise * @since 3.0 */ protected void handleAdvertisingResult( @@ -393,6 +412,8 @@ public abstract class AbstractTopologyManager { } /** + * @param event the service event + * @param listeners map of listeners * @since 3.0 */ protected void handleEvent(ServiceEvent event, Map listeners) { diff --git a/osgi/bundles/org.eclipse.ecf.osgi.services.remoteserviceadmin/src/org/eclipse/ecf/osgi/services/remoteserviceadmin/EndpointDescription.java b/osgi/bundles/org.eclipse.ecf.osgi.services.remoteserviceadmin/src/org/eclipse/ecf/osgi/services/remoteserviceadmin/EndpointDescription.java index a348fecc7..897bb7975 100644 --- a/osgi/bundles/org.eclipse.ecf.osgi.services.remoteserviceadmin/src/org/eclipse/ecf/osgi/services/remoteserviceadmin/EndpointDescription.java +++ b/osgi/bundles/org.eclipse.ecf.osgi.services.remoteserviceadmin/src/org/eclipse/ecf/osgi/services/remoteserviceadmin/EndpointDescription.java @@ -33,14 +33,12 @@ import org.osgi.framework.Version; * href="http://www.osgi.org/download/r4v42/r4.enterprise.pdf">OSGi 4.2 * Enterprise Specification</a>. * <p> - * <p> * ECF remote services have capabilities beyond typical OSGi remote services. To * expose these capabilities, this EndpointDescription adds <b>optional</b> * meta-data. This meta-data may then be used by the remote service consumer to * customize ECF remote services import. Specifically, to customize the behavior * of the ECF implementation of * {@link RemoteServiceAdmin#importService(org.osgi.service.remoteserviceadmin.EndpointDescription)}. - * <p> */ public class EndpointDescription extends org.osgi.service.remoteserviceadmin.EndpointDescription { @@ -190,11 +188,11 @@ public class EndpointDescription extends } } /** - * Get a map of the service interface name -> Version information for all + * Get a map of the service interface name to Version information for all * the service interfaces exposed by this endpoint description (i.e. those * returned by {@link #getInterfaces()} which have a * - * @return Map<String,Version> of interface versions for all our service + * @return Map of interface versions for all our service * interfaces. Every service interface returned by * {@link #getInterfaces()} will have an associated Version, but it * may have value Version#emptyVersion @@ -207,6 +205,7 @@ public class EndpointDescription extends } /** + * @return String ecf endpoint id * @since 4.0 */ public String getEndpointId() { @@ -214,6 +213,7 @@ public class EndpointDescription extends } /** + * @return Long ecf timestamp * @since 4.0 */ public Long getTimestamp() { @@ -221,6 +221,7 @@ public class EndpointDescription extends } /** + * @return Long ecf remote service id * @since 4.0 */ public Long getRemoteServiceId() { @@ -294,6 +295,7 @@ public class EndpointDescription extends } /** + * @return List ecf asynchronous proxy interfaces * @since 4.0 */ public List<String> getAsyncInterfaces() { diff --git a/osgi/bundles/org.eclipse.ecf.osgi.services.remoteserviceadmin/src/org/eclipse/ecf/osgi/services/remoteserviceadmin/EndpointDescriptionLocator.java b/osgi/bundles/org.eclipse.ecf.osgi.services.remoteserviceadmin/src/org/eclipse/ecf/osgi/services/remoteserviceadmin/EndpointDescriptionLocator.java index 8639c7b0d..988caa551 100644 --- a/osgi/bundles/org.eclipse.ecf.osgi.services.remoteserviceadmin/src/org/eclipse/ecf/osgi/services/remoteserviceadmin/EndpointDescriptionLocator.java +++ b/osgi/bundles/org.eclipse.ecf.osgi.services.remoteserviceadmin/src/org/eclipse/ecf/osgi/services/remoteserviceadmin/EndpointDescriptionLocator.java @@ -765,6 +765,9 @@ public class EndpointDescriptionLocator implements IEndpointDescriptionLocator { } /** + * @param description description + * @param type type + * @return EndpointEventListenerHolder[] matching endpoint event listener holders * @since 4.1 */ protected EndpointEventListenerHolder[] getMatchingEndpointEventListenerHolders( @@ -843,6 +846,10 @@ public class EndpointDescriptionLocator implements IEndpointDescriptionLocator { } /** + * @param refs service references + * @param description description + * @param type type + * @return EndpointEventListenerHolder[] matching endpoint event listener holders * @since 4.1 */ public EndpointEventListenerHolder[] getMatchingEndpointEventListenerHolders( diff --git a/osgi/bundles/org.eclipse.ecf.osgi.services.remoteserviceadmin/src/org/eclipse/ecf/osgi/services/remoteserviceadmin/EndpointDescriptionWriter.java b/osgi/bundles/org.eclipse.ecf.osgi.services.remoteserviceadmin/src/org/eclipse/ecf/osgi/services/remoteserviceadmin/EndpointDescriptionWriter.java index 6955ccdbd..7700131e2 100644 --- a/osgi/bundles/org.eclipse.ecf.osgi.services.remoteserviceadmin/src/org/eclipse/ecf/osgi/services/remoteserviceadmin/EndpointDescriptionWriter.java +++ b/osgi/bundles/org.eclipse.ecf.osgi.services.remoteserviceadmin/src/org/eclipse/ecf/osgi/services/remoteserviceadmin/EndpointDescriptionWriter.java @@ -194,6 +194,9 @@ public class EndpointDescriptionWriter { } /** + * @param endpointDescription the endpoint description to write + * @return Writer the writer used + * @throws IOException if endpoint descriptino cannot be written * @since 4.2 */ public Writer writeEndpointDescription( @@ -203,6 +206,9 @@ public class EndpointDescriptionWriter { } /** + * @param endpointDescriptions the endpoint descriptions to write + * @return Writer used to write descriptions + * @throws IOException if problem writing * @since 4.2 */ public Writer writeEndpointDescriptions( @@ -216,6 +222,9 @@ public class EndpointDescriptionWriter { } /** + * @param writer the writer to use + * @param endpointDescription the endpointDescription to write + * @throws IOException thrown if some problem writing * @since 4.2 */ public void writeEndpointDescription( diff --git a/osgi/bundles/org.eclipse.ecf.osgi.services.remoteserviceadmin/src/org/eclipse/ecf/osgi/services/remoteserviceadmin/IConsumerContainerSelector.java b/osgi/bundles/org.eclipse.ecf.osgi.services.remoteserviceadmin/src/org/eclipse/ecf/osgi/services/remoteserviceadmin/IConsumerContainerSelector.java index e344da639..bf5884254 100644 --- a/osgi/bundles/org.eclipse.ecf.osgi.services.remoteserviceadmin/src/org/eclipse/ecf/osgi/services/remoteserviceadmin/IConsumerContainerSelector.java +++ b/osgi/bundles/org.eclipse.ecf.osgi.services.remoteserviceadmin/src/org/eclipse/ecf/osgi/services/remoteserviceadmin/IConsumerContainerSelector.java @@ -19,11 +19,9 @@ import org.eclipse.ecf.remoteservice.IRemoteServiceContainer; * and then uses it to select an ECF consumer container instance by calling * {@link #selectConsumerContainer(EndpointDescription)}. * <p> - * <p> * The {@link IRemoteServiceContainer} returned is then used on the consumer * side, to actually import the remote service. * <p> - * <p> * If no other instances of this service have been registered, a default * instance of {@link ConsumerContainerSelector} will be used. Note that this * default instance is registered with the lowest possible priority, so that if 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 b614a114e..6ecd8a5f9 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 @@ -33,13 +33,12 @@ import org.eclipse.ecf.discovery.identity.IServiceID; * will be preferred/used over the default. This means that those wishing to * customize/control this process of converting {@link IServiceInfo}s to * {@link DiscoveredEndpointDescription} must - * <ul> - * <li>create their own implementation of - * {@link IDiscoveredEndpointDescriptionFactory}</li> - * <li>register it with the OSGi service registry with a priority + * create their own implementation of + * {@link IDiscoveredEndpointDescriptionFactory} + * and register it with the OSGi service registry with a priority * ({org.osgi.framework.Constants#SERVICE_RANKING}) higher than - * {@link Integer#MIN_VALUE}</li> - * <ul> + * {@link Integer#MIN_VALUE} + * <p> * Then at runtime, when needed by the {@link EndpointDescriptionLocator}, the * new discovered endpoint description factory will be used. * 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 e7555b4d0..46cbf6948 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 @@ -26,7 +26,7 @@ public interface IEndpointDescriptionLocator { /** * Get the service ID associated with the given endpoint description. * - * @param endpointDescription + * @param endpointDescription endpoint description * @return IServiceID associated discovered endpoint description. Will * return <code>null</code> if no associated serviceID */ 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 7f2d37fdc..eaee91c9a 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,15 +21,12 @@ 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, Map<String,Object>, String[], - * String[], String[])} . - * <p> + * selectHostContainers. * <p> * The {@link IRemoteServiceContainer} array returned is then used to actually * export the remote service (typically via * {@link IRemoteServiceContainerAdapter#registerRemoteService(String[], Object, java.util.Dictionary)} * <p> - * <p> * If no other instances of this service have been registered, a default * instance of {@link HostContainerSelector} will be used. Note that this * default instance is registered with the lowest possible priority, so that if 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 3b04d004c..3f97ebcc9 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 @@ -15,11 +15,10 @@ import org.eclipse.ecf.discovery.IServiceInfo; /** * 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 + * createServiceInfo. The * 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. Note that this default * instance is registered with the lowest possible priority, so that if other @@ -32,8 +31,8 @@ import org.eclipse.ecf.discovery.IServiceInfo; * <li>register it with the OSGi service registry with a priority * ({org.osgi.framework.Constants#SERVICE_RANKING}) higher than * {@link Integer#MIN_VALUE}</li> - * <ul> - * Then at runtime, when needed by the {@link EndpointDescriptionAdvertiser}, + * </ul> + * Then at runtime, when needed by the EndpointDescriptionAdvertiser, * the new service info factory will be used. * * @see IDiscoveredEndpointDescriptionFactory 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 41a15fa07..9d3607544 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 @@ -42,7 +42,7 @@ public final class RemoteConstants { /** * ECF discovery scope property. Value type is String+. If set, the value * will be used by the {@link IServiceInfoFactory} during - * {@link IServiceInfoFactory#createServiceInfo(org.eclipse.ecf.discovery.IDiscoveryAdvertiser, EndpointDescription)} + * IServiceInfoFactory#createServiceInfo(org.eclipse.ecf.discovery.IDiscoveryAdvertiser, EndpointDescription) * to create an {@link IServiceTypeID} via * {@link IServiceIDFactory#createServiceTypeID(org.eclipse.ecf.core.identity.Namespace, String[], String[], String[], String)} * . The scopes value determines the third parameter. If not explicitly set, @@ -52,7 +52,7 @@ public final class RemoteConstants { /** * ECF discovery protocols property. Value type is String+. If set, the * value will be used by the {@link IServiceInfoFactory} during - * {@link IServiceInfoFactory#createServiceInfo(org.eclipse.ecf.discovery.IDiscoveryAdvertiser, EndpointDescription)} + * IServiceInfoFactory#createServiceInfo(org.eclipse.ecf.discovery.IDiscoveryAdvertiser, EndpointDescription) * to create an {@link IServiceTypeID} via * {@link IServiceIDFactory#createServiceTypeID(org.eclipse.ecf.core.identity.Namespace, String[], String[], String[], String)} * . The protocols value determines the fourth parameter. If not explicitly @@ -62,7 +62,7 @@ public final class RemoteConstants { /** * ECF discovery naming authority property. Value type is String. If set, * the value will be used by the {@link IServiceInfoFactory} during - * {@link IServiceInfoFactory#createServiceInfo(org.eclipse.ecf.discovery.IDiscoveryAdvertiser, EndpointDescription)} + * IServiceInfoFactory#createServiceInfo(org.eclipse.ecf.discovery.IDiscoveryAdvertiser, EndpointDescription) * to create an {@link IServiceTypeID} via * {@link IServiceIDFactory#createServiceTypeID(org.eclipse.ecf.core.identity.Namespace, String[], String[], String[], String)} * . The protocols value determines the fifth parameter. If not explicitly @@ -72,7 +72,7 @@ public final class RemoteConstants { /** * ECF discovery service name property. Value type is String. If set, the * value will be used by the {@link IServiceInfoFactory} during - * {@link IServiceInfoFactory#createServiceInfo(org.eclipse.ecf.discovery.IDiscoveryAdvertiser, EndpointDescription)} + * IServiceInfoFactory#createServiceInfo(org.eclipse.ecf.discovery.IDiscoveryAdvertiser, EndpointDescription) * to create an {@link IServiceInfo} with a given name. The default is a * globally unique identifier. Note that if this value is explicitly set, * care should be taken to not have the name conflict with other remote @@ -186,7 +186,7 @@ public final class RemoteConstants { * <li>The fully qualified name of an interface that follows the * asynchronous proxy conventions to match with one of the existing exported * types.</li> - * + * </ol> * <p> * This property may be supplied in the {@code properties} * {@code Dictionary} object passed to the diff --git a/osgi/bundles/org.eclipse.ecf.osgi.services.remoteserviceadmin/src/org/eclipse/ecf/osgi/services/remoteserviceadmin/RemoteServiceAdmin.java b/osgi/bundles/org.eclipse.ecf.osgi.services.remoteserviceadmin/src/org/eclipse/ecf/osgi/services/remoteserviceadmin/RemoteServiceAdmin.java index 2b6d0d789..b4d73e077 100644 --- a/osgi/bundles/org.eclipse.ecf.osgi.services.remoteserviceadmin/src/org/eclipse/ecf/osgi/services/remoteserviceadmin/RemoteServiceAdmin.java +++ b/osgi/bundles/org.eclipse.ecf.osgi.services.remoteserviceadmin/src/org/eclipse/ecf/osgi/services/remoteserviceadmin/RemoteServiceAdmin.java @@ -136,6 +136,7 @@ public class RemoteServiceAdmin implements private ServiceRegistration eventListenerHookRegistration; /** + * @return List of exported registrations * @since 4.2 */ public List<ExportRegistration> getExportedRegistrations() { @@ -145,6 +146,7 @@ public class RemoteServiceAdmin implements } /** + * @return List of imported registrations * @since 4.2 */ public List<ImportRegistration> getImportedRegistrations() { @@ -161,6 +163,9 @@ public class RemoteServiceAdmin implements } /** + * @param clientBundle client bundle for RemoteServiceAdmin instance + * @param exportedRegistrations of exported registrations + * @param importedRegistrations of imported registrations * @since 4.1 */ public RemoteServiceAdmin(Bundle clientBundle, Collection<org.osgi.service.remoteserviceadmin.ExportRegistration> exportedRegistrations, Collection<org.osgi.service.remoteserviceadmin.ImportRegistration> importedRegistrations) { @@ -2601,6 +2606,7 @@ public class RemoteServiceAdmin implements } /** + * @return EndpointDescription for this remote service admin event * @since 3.0 */ public EndpointDescription getEndpointDescription() { diff --git a/osgi/bundles/org.eclipse.ecf.osgi.services.remoteserviceadmin/src/org/eclipse/ecf/osgi/services/remoteserviceadmin/ServiceInfoFactory.java b/osgi/bundles/org.eclipse.ecf.osgi.services.remoteserviceadmin/src/org/eclipse/ecf/osgi/services/remoteserviceadmin/ServiceInfoFactory.java index f8159d356..f6ba78c64 100644 --- a/osgi/bundles/org.eclipse.ecf.osgi.services.remoteserviceadmin/src/org/eclipse/ecf/osgi/services/remoteserviceadmin/ServiceInfoFactory.java +++ b/osgi/bundles/org.eclipse.ecf.osgi.services.remoteserviceadmin/src/org/eclipse/ecf/osgi/services/remoteserviceadmin/ServiceInfoFactory.java @@ -68,6 +68,12 @@ public class ServiceInfoFactory extends AbstractMetadataFactory implements } /** + * @param endpointDescription endpoint description + * @param advertiser advertiser + * @param serviceTypeID serviceTypeID + * @param serviceName serviceName + * @param uri uri + * @return IServiceProperties for the given input parameters * @since 3.0 */ protected IServiceProperties createServiceProperties( @@ -80,6 +86,12 @@ public class ServiceInfoFactory extends AbstractMetadataFactory implements } /** + * @param endpointDescription endpoint description + * @param advertiser advertiser + * @param serviceTypeID serviceTypeID + * @param serviceName service name + * @return URI created + * @throws URISyntaxException thrown if URI cannot be created * @since 3.0 */ protected URI createURI( @@ -134,6 +146,10 @@ public class ServiceInfoFactory extends AbstractMetadataFactory implements } /** + * @param endpointDescription endpoint description + * @param advertiser advertiser + * @param serviceTypeID serviceTypeID + * @return String created service name for input parameters * @since 3.0 */ protected String createServiceName( @@ -150,6 +166,10 @@ public class ServiceInfoFactory extends AbstractMetadataFactory implements } /** + * @param endpointDescription endpoint description + * @param advertiser advertiser + * @param serviceTypeID serviceTypeID + * @return String default service name created * @since 3.0 */ protected String createDefaultServiceName( @@ -160,6 +180,9 @@ public class ServiceInfoFactory extends AbstractMetadataFactory implements } /** + * @param endpointDescription endpoint description + * @param advertiser advertiser + * @return IServiceTypeID created service type ID * @since 3.0 */ protected IServiceTypeID createServiceTypeID( |