Skip to content

Commit

Permalink
One more round of javadoc fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
akurtakov committed Dec 12, 2024
1 parent e67f0f8 commit f79ad7d
Show file tree
Hide file tree
Showing 7 changed files with 27 additions and 27 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -23,30 +23,34 @@
* with roles. Before granting access to a restricted resource or operation, a
* bundle will check if the Authorization object passed to it possesses the
* required role, by calling its hasRole method.
* </p>
* <p>
* Authorization contexts are instantiated by calling
* {@link UserAdmin#getAuthorization}
* <p>
* </p>
* <h2>Trusting Authorization objects.</h2>
* <p>
* There are no restrictions regarding the creation of Authorization objects.
* Hence, a service must only accept Authorization objects from bundles that has
* been authorized to use the service using code based (or Java 2) permissions.
* </p>
* <p>
* In some cases it is useful to use ServicePermissions to do the code based
* access control. A service basing user access control on Authorization objects
* passed to it, will then require that a calling bundle has the
* ServicePermission to get the service in question. This is the most convenient
* way. The framework will do the code based permission check when the calling
* bundle attempts to get the service from the service registry.
* </p>
* <p>
* Example: A servlet using a service on a user's behalf. The bundle with the
* servlet must be given the ServicePermission to get the Service.
* </p>
* <p>
* However, in some cases the code based permission checks need to be more
* fine-grained. A service might allow all bundles to get it, but require
* certain code based permissions for some of its methods.
* <p>
* </p>
* Example: A servlet using a service on a user's behalf, where some service
* functionality is open to anyone, and some is restricted by code based
* permissions. When a restricted method is called (e.g., one handing over an
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ public class FrameworkDebugOptions
private Properties disabledOptions = null;
/**
* A cache of all of the bundles <code>DebugTrace</code> in the format
* <key,value> --> <bundle name, DebugTrace>
* {@code <key,value> --> <bundle name, DebugTrace>}
*/
protected final Map<String, DebugTrace> debugTraceCache = new HashMap<>();
/** The File object to store messages. This value may be null. */
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -342,11 +342,11 @@ public void publishFrameworkEventPrivileged(FrameworkEvent event, FrameworkListe
}

/**
* Coerce the generic type of a collection from Collection<BundleContextImpl> to
* Collection<BundleContext>
* Coerce the generic type of a collection from
* {@code Collection<BundleContextImpl>} to {@code Collection<BundleContext>}
*
* @param c Collection to be coerced.
* @return c coerced to Collection<BundleContext>
* @return c coerced to {@code Collection<BundleContext>}
*/
@SuppressWarnings("unchecked")
public static Collection<BundleContext> asBundleContexts(Collection<? extends BundleContext> c) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@
* that keys in the match argument must always be strings. The comparison is
* defined by the object type of the key's value. The following rules apply for
* comparison: <blockquote>
* <TABLE BORDER=0>
* <TABLE>
* <TR>
* <TD><b>Property Value Type </b></TD>
* <TD><b>Comparison Type</b></TD>
Expand All @@ -121,7 +121,7 @@
* <TD>String</TD>
* <TD>String comparison</TD>
* </TR>
* <TR valign=top>
* <TR>
* <TD>Integer, Long, Float, Double, Byte, Short, BigInteger, BigDecimal</TD>
* <TD>numerical comparison</TD>
* </TR>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -103,25 +103,21 @@ public HookRegistry(EquinoxContainer container) {
/**
* Initializes the hook configurators. The following steps are used to
* initialize the hook configurators.
* <p>
* 1. Get a list of hook configurators from all hook configurators properties
* <ol>
* <li>Get a list of hook configurators from all hook configurators properties
* files on the classpath, add this list to the overall list of hook
* configurators, remove duplicates.
* <p>
* 2. Get a list of hook configurators from the
* configurators, remove duplicates.</li>
* <li>Get a list of hook configurators from the
* (&quot;osgi.hook.configurators.include&quot;) system property and add this
* list to the overall list of hook configurators, remove duplicates.
* <p>
* 3. Get a list of hook configurators from the
* list to the overall list of hook configurators, remove duplicates.</li>
* <li>Get a list of hook configurators from the
* (&quot;osgi.hook.configurators.exclude&quot;) system property and remove this
* list from the overall list of hook configurators.
* <p>
* 4. Load each hook configurator class, create a new instance, then call the
* {@link HookConfigurator#addHooks(HookRegistry)} method
* <p>
* 5. Set this HookRegistry object to read only to prevent any other hooks from
* being added.
* <p>
* list from the overall list of hook configurators.</li>
* <li>Load each hook configurator class, create a new instance, then call the
* {@link HookConfigurator#addHooks(HookRegistry)} method</li>
* <li>Set this HookRegistry object to read only to prevent any other hooks from
* being added.</li>
* </ol>
*/
public void initialize() {
List<String> configurators = new ArrayList<>(5);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,6 @@
* A StorageHookFactory hooks into the persistent storage loading and saving of
* bundle {@link Generation generations}. A factory creates StorageHook
* instances that get associated with each Generation object installed.
* <p>
*
* @see Generation#getStorageHook(Class)
* @param <S> the save context type
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,9 @@ public abstract class MultiplexingFactory {
/**
* As a short-term (hopefully) solution we use a special class which is defined
* using the Unsafe class from the VM. This class is an implementation of
* Collection<AccessibleObject> simply to provide a method add(AccessibleObject)
* which turns around and calls AccessibleObject.setAccessible(true).
* {@code Collection<AccessibleObject>} simply to provide a method
* add(AccessibleObject) which turns around and calls
* AccessibleObject.setAccessible(true).
* <p>
* The reason this is needed is to hack into the VM to get deep reflective
* access to the java.net package for the various hacks we have to do to
Expand Down

0 comments on commit f79ad7d

Please sign in to comment.