1
0
mirror of synced 2026-08-05 09:47:05 +00:00

Replace package.html with package-info.java files, creating new ones where missing and updating outdated contents.

This commit is contained in:
Luke Taylor
2010-02-14 23:23:23 +00:00
parent e729819ce0
commit 36612377e2
124 changed files with 499 additions and 341 deletions
@@ -0,0 +1,4 @@
/**
* Support for JSR-250 and Spring Security {@code @Secured} annotations.
*/
package org.springframework.security.access.annotation;
@@ -0,0 +1,4 @@
/**
* Authorization event and listener classes.
*/
package org.springframework.security.access.event;
@@ -0,0 +1,6 @@
/**
* Implementation of expression-based method security.
*
* @since 3.0
*/
package org.springframework.security.access.expression.method;
@@ -0,0 +1,7 @@
/**
* Expression handling code to support the use of Spring-EL based expressions in {@code @PreAuthorize}, {@code @PreFilter},
* {@code @PostAuthorize} and {@code @PostFilter} annotations. Mainly for internal framework use and liable to change.
*
* @since 3.0
*/
package org.springframework.security.access.expression;
@@ -1,8 +0,0 @@
<html>
<body>
<p>
Expression handling code to support the use of Spring-EL based expressions in @PreAuthorize, @PreFilter,
@PostAuthorizue and @PostFilter annotations. Mainly for internal framework use and liable to change.
</p>
</body>
</html>
@@ -0,0 +1,4 @@
/**
* Role hierarchy implementation.
*/
package org.springframework.security.access.hierarchicalroles;
@@ -0,0 +1,4 @@
/**
* Enforces security for AOP Alliance <code>MethodInvocation</code>s, such as via Spring AOP.
*/
package org.springframework.security.access.intercept.aopalliance;
@@ -1,6 +0,0 @@
<html>
<body>
Enforces security for AOP Alliance <code>MethodInvocation</code>s, such as via
Spring AOP.
</body>
</html>
@@ -0,0 +1,4 @@
/**
* Enforces security for AspectJ <code>JointPoint</code>s, delegating secure object callbacks to the calling aspect.
*/
package org.springframework.security.access.intercept.aspectj;
@@ -1,8 +0,0 @@
<html>
<body>
Enforces security for AspectJ <code>JointPoint</code>s, delegating secure
object callbacks to the calling aspect.
<p>Refer to the reference guide for information on usage.
</body>
</html>
@@ -0,0 +1,21 @@
/**
* Abstract level security interception classes which are responsible for enforcing the
* configured security constraints for a secure object.
* <p>
* A <i>secure object</i> is a term frequently used throughout the security
* system. It does <b>not</b> refer to a business object that is being
* secured, but instead refers to some infrastructure object that can have
* security facilities provided for it by Spring Security.
* For example, one secure object would be <code>MethodInvocation</code>,
* whilst another would be HTTP
* {@link org.springframework.security.web.FilterInvocation}. Note these are
* infrastructure objects and their design allows them to represent a large
* variety of actual resources that might need to be secured, such as business
* objects or HTTP request URLs.
* <p>Each secure object typically has its own interceptor package.
* Each package usually includes a concrete security interceptor (which subclasses
* {@link org.springframework.security.access.intercept.AbstractSecurityInterceptor}) and an
* appropriate {@link org.springframework.security.access.SecurityMetadataSource}
* for the type of resources the secure object represents.
*/
package org.springframework.security.access.intercept;
@@ -1,26 +0,0 @@
<html>
<body>
Actually enforces the security and ties the whole security system together.
<p>
A <i>secure object</i> is a term frequently used throughout the security
system. It does <b>not</b> refer to a business object that is being
secured, but instead refers to some infrastructure object that can have
security facilities provided for it by Spring Security.
For example, one secure object would be <code>MethodInvocation</code>,
whilst another would be HTTP
{@link org.springframework.security.web.FilterInvocation}. Note these are
infrastructure objects and their design allows them to represent a large
variety of actual resources that might need to be secured, such as business
objects or HTTP request URLs.
</p>
<p>Each secure object typically has its
own interceptor package.
Each package usually includes a concrete security interceptor (which
subclasses {@link org.springframework.security.access.intercept.AbstractSecurityInterceptor},
an appropriate {@link org.springframework.security.access.SecurityMetadataSource}
for the type of resources the secure object represents, and a property editor
to populate the <code>SecurityMetadataSource</code>.
</body>
</html>
@@ -0,0 +1,5 @@
/**
* Provides {@code SecurityMetadataSource} implementations for securing Java method invocations via different
* AOP libraries.
*/
package org.springframework.security.access.method;
@@ -1,6 +0,0 @@
<html>
<body>
Provides support objects for securing Java method invocations
via different AOP libraries.
</body>
</html>
@@ -0,0 +1,7 @@
/**
* Core access-control related code, including security metadata related classes, interception code, access control
* annotations, EL support and voter-based implementations of the central
* {@link org.springframework.security.access.AccessDecisionManager AccessDecisionManager} interface.
*/
package org.springframework.security.access;
@@ -1,11 +0,0 @@
<html>
<body>
Core access-control related code, including
<ul>
<li>security metadata related classes</li>
<li>interception code</li>
<li>Security access control annotations</li>
<li>Voter-based AccessDecisionManager implementations</li>
</ul>
</body>
</html>
@@ -0,0 +1,8 @@
/**
* Contains the infrastructure classes for handling the {@code @PreAuthorize}, {@code @PreFilter}, {@code @PostAuthorize}
* and {@code @PostFilter} annotations.
* <p>
* Other than the annotations themselves, the classes should be regarded as for internal framework use and
* are liable to change without notice.
*/
package org.springframework.security.access.prepost;
@@ -1,10 +0,0 @@
<html>
<body>
<p>
Contains the infrastructure classes for handling the @PreAuthorize, @PreFilter, @PostAuthorize and
@PostFilter annotations.
</p>
Other than the annotations themselves, the classes should be regarded as for internal framework use and
are liable to change without notice.
</body>
</html>
@@ -0,0 +1,4 @@
/**
* Implements a vote-based approach to authorization decisions.
*/
package org.springframework.security.access.vote;
@@ -1,6 +0,0 @@
<html>
<body>
Implements a vote-based approach to authorization decisions.
<p>
</body>
</html>
@@ -0,0 +1,4 @@
/**
* An {@code AuthenticationProvider} which relies upon a data access object.
*/
package org.springframework.security.authentication.dao;
@@ -1,5 +0,0 @@
<html>
<body>
An authentication provider that relies upon a data access object.
</body>
</html>
@@ -0,0 +1,10 @@
/**
* Password encoding implementations. Apart from the "null" implementations, they are all based on
* password hashing using digest functions. See the
* <a href="http://static.springsource.org/spring-security/site/docs/3.0.x/reference/core-services.html#core-services-password-encoding">
* reference manual</a> for more information.
* <p>
* Third part implementations such as those provided by <a href="http://www.jasypt.org/springsecurity.html">Jasypt</a>
* can also be used.
*/
package org.springframework.security.authentication.encoding;
@@ -1,5 +0,0 @@
<html>
<body>
Password encoding implementations.
</body>
</html>
@@ -0,0 +1,8 @@
/**
* Authentication success and failure events which can be published to the Spring application context.
*
* The <code>ProviderManager</code> automatically publishes events to the application context. These events are
* received by all registered Spring <code>ApplicationListener</code>s.
*/
package org.springframework.security.authentication.event;
@@ -1,9 +0,0 @@
<html>
<body>
Enables authentication events to be published to the Spring application context.
<p>The <code>ProviderManager</code> automatically publishes
events to the application context. These events are received by all
registered Spring <code>ApplicationListener</code>s.</p>
</body>
</html>
@@ -0,0 +1,5 @@
/**
* JAAS authentication events which can be published to the Spring application context by the JAAS authentication
* provider.
*/
package org.springframework.security.authentication.jaas.event;
@@ -1,5 +0,0 @@
<html>
<body>
Enables JAAS events to be published to the Spring application context.
</body>
</html>
@@ -0,0 +1,4 @@
/**
* An authentication provider for JAAS.
*/
package org.springframework.security.authentication.jaas;
@@ -1,5 +0,0 @@
<html>
<body>
An authentication provider for JAAS.
</body>
</html>
@@ -0,0 +1,9 @@
/**
* Core classes and interfaces related to user authentication, which are used throughout Spring Security.
* <p>
* Of key importance is the {@link org.springframework.security.authentication.AuthenticationManager AuthenticationManager}
* and its default implementation {@link org.springframework.security.authentication.ProviderManager
* ProviderManager}, which maintains a list {@link org.springframework.security.authentication.AuthenticationProvider
* AuthenticationProvider}s to which it delegates authentication requests.
*/
package org.springframework.security.authentication;
@@ -1,6 +0,0 @@
<html>
<body>
Implements a provider-based approach to authentication decisions.
<p>
</body>
</html>
@@ -0,0 +1,4 @@
/**
* Allows remote clients to authenticate and obtain a populated <code>Authentication</code> object.
*/
package org.springframework.security.authentication.rcp;
@@ -1,7 +0,0 @@
<html>
<body>
Allows remote clients to authenticate and obtain a populated
<code>Authentication</code> object.
</body>
</html>
@@ -0,0 +1,8 @@
/**
* Strategies for mapping a list of attributes (such as roles or LDAP groups) to a list of
* {@code GrantedAuthority}s.
* <p>
* Provides a layer of indirection between a security data repository and the logical authorities
* required within an application.
*/
package org.springframework.security.core.authority.mapping;
@@ -0,0 +1,4 @@
/**
* The default implementation of the {@code GrantedAuthority} interface.
*/
package org.springframework.security.core.authority;
@@ -0,0 +1,4 @@
/**
* Internal codec classes. Only intended for use within the framework.
*/
package org.springframework.security.core.codec;
@@ -0,0 +1,11 @@
/**
* Classes related to the establishment of a security context for the duration of a request (such as
* an HTTP or RMI invocation).
* <p>
* A security context is usually associated with the current execution thread for the duration of the request,
* making the authentication information it contains available throughout all the layers of an application.
* <p>
* The {@link org.springframework.security.core.context.SecurityContext SecurityContext} can be accessed at any point
* by calling the {@link org.springframework.security.core.context.SecurityContextHolder SecurityContextHolder}.
*/
package org.springframework.security.core.context;
@@ -1,10 +0,0 @@
<html>
<body>
Classes related to the establishment of a security context for the duration of a request (such as
an HTTP or RMI invocation).
<p>
A security context is associated with the current execution thread for the duration of the request, making the
authentication information it contains available throughout all the layers of an application.
</body>
</html>
@@ -0,0 +1,5 @@
/**
* Core classes and interfaces related to user authentication and authorization, as well as the maintenance of
* a security context.
*/
package org.springframework.security.core;
@@ -0,0 +1,6 @@
/**
* Session abstraction which is provided by the {@code org.springframework.security.core.session.SessionInformation
* SessionInformation} class. The {@link org.springframework.security.core.session.SessionRegistry SessionRegistry}
* is a core part of the web-based concurrent session control, but the code is not dependent on any of the servlet APIs.
*/
package org.springframework.security.core.session;
@@ -1,6 +0,0 @@
<html>
<body>
Session registry and other related classes.
</body>
</html>
@@ -0,0 +1,4 @@
/**
* A service for building secure random tokens.
*/
package org.springframework.security.core.token;
@@ -0,0 +1,4 @@
/**
* Implementations of {@link org.springframework.security.core.userdetails.UserCache UserCache}.
*/
package org.springframework.security.core.userdetails.cache;
@@ -0,0 +1,5 @@
/**
* Exposes a JDBC-based authentication repository, implementing
* {@code org.springframework.security.core.userdetails.UserDetailsService UserDetailsService}.
*/
package org.springframework.security.core.userdetails.jdbc;
@@ -1,5 +0,0 @@
<html>
<body>
Exposes a JDBC-based authentication repository.
</body>
</html>
@@ -0,0 +1,4 @@
/**
* Exposes an in-memory authentication repository.
*/
package org.springframework.security.core.userdetails.memory;
@@ -1,6 +0,0 @@
<html>
<body>
Exposes an in-memory authentication repository.
</body>
</html>
@@ -0,0 +1,8 @@
/**
* The standard interfaces for implementing user data DAOs.
* <p>
* Can be the traditional {@link org.springframework.security.core.userdetails.UserDetailsService UserDetailsService}
* which uses a unique username to identify the user or, for more complex requirements, the
* {@link org.springframework.security.core.userdetails.AuthenticationUserDetailsService AuthenticationUserDetailsService}.
*/
package org.springframework.security.core.userdetails;
@@ -0,0 +1,5 @@
/**
* Contains simple user and authority group account provisioning interfaces together with a a
* JDBC-based implementation.
*/
package org.springframework.security.provisioning;
@@ -1,6 +0,0 @@
<html>
<body>
<p>Contains simple user and authority group account provisioning interfaces together with a
a JDBC-based implementation.</p>
</body>
</html>
@@ -0,0 +1,4 @@
/**
* DNS resolution.
*/
package org.springframework.security.remoting.dns;
@@ -0,0 +1,19 @@
/**
* Enables use of Spring's <code>HttpInvoker</code> extension points to
* present the <code>principal</code> and <code>credentials</code> located
* in the <code>ContextHolder</code> via BASIC authentication.
* <p>
* The beans are wired as follows:
*
* <pre>
* &lt;bean id="test" class="org.springframework.remoting.httpinvoker.HttpInvokerProxyFactoryBean"&gt;
* &lt;property name="serviceUrl"&gt;&lt;value&gt;http://localhost/Test&lt;/value&gt;&lt;/property&gt;
* &lt;property name="serviceInterface"&gt;&lt;value&gt;test.TargetInterface&lt;/value&gt;&lt;/property&gt;
* &lt;property name="httpInvokerRequestExecutor"&gt;&lt;ref bean="httpInvokerRequestExecutor"/&gt;&lt;/property&gt;
* &lt;/bean&gt;
*
* &lt;bean id="httpInvokerRequestExecutor"
* class="org.springframework.security.core.context.httpinvoker.AuthenticationSimpleHttpInvokerRequestExecutor"/&gt;
* </pre>
*/
package org.springframework.security.remoting.httpinvoker;
@@ -1,21 +0,0 @@
<html>
<body>
Enables use of Spring's <code>HttpInvoker</code> extension points to
present the <code>principal</code> and <code>credentials</code> located
in the <code>ContextHolder</code> via BASIC authentication.
<P>The beans are wired as follows:
<P>
<code>
&lt;bean id="test" class="org.springframework.remoting.httpinvoker.HttpInvokerProxyFactoryBean"&gt;<BR>
&lt;property name="serviceUrl"&gt;&lt;value&gt;http://localhost/Test&lt;/value&gt;&lt;/property&gt;<BR>
&lt;property name="serviceInterface"&gt;&lt;value&gt;test.TargetInterface&lt;/value&gt;&lt;/property&gt;<BR>
&lt;property name="httpInvokerRequestExecutor"&gt;&lt;ref bean="httpInvokerRequestExecutor"/&gt;&lt;/property&gt;<BR>
&lt;/bean&gt;<BR>
<BR>
&lt;bean id="httpInvokerRequestExecutor" class="org.springframework.security.core.context.httpinvoker.AuthenticationSimpleHttpInvokerRequestExecutor"/&gt;<BR>
</code>
</body>
</html>
@@ -0,0 +1,4 @@
/**
* Remote client related functionality.
*/
package org.springframework.security.remoting;
@@ -0,0 +1,18 @@
/**
* Enables use of Spring's RMI remoting extension points to propagate the <code>SecurityContextHolder</code> (which
* should contain an <code>Authentication</code> request token) from one JVM to the remote JVM.
* <p>
* The beans are wired as follows:
* <pre>
* &lt;bean id="test" class="org.springframework.remoting.rmi.RmiProxyFactoryBean"&gt;
* &lt;property name="serviceUrl"&gt;&lt;value&gt;rmi://localhost/Test&lt;/value&gt;&lt;/property&gt;
* &lt;property name="serviceInterface"&gt;&lt;value&gt;test.TargetInterface&lt;/value&gt;&lt;/property&gt;
* &lt;property name="refreshStubOnConnectFailure"&gt;&lt;value&gt;true&lt;/value&gt;&lt;/property&gt;
* &lt;property name="remoteInvocationFactory"&gt;&lt;ref bean="remoteInvocationFactory"/&gt;&lt;/property&gt;
* &lt;/bean&gt;
*
* &lt;bean id="remoteInvocationFactory"
* class="org.springframework.security.remoting.rmi.ContextPropagatingRemoteInvocationFactory"/&gt;
* </pre>
*/
package org.springframework.security.remoting.rmi;
@@ -1,23 +0,0 @@
<html>
<body>
Enables use of Spring's RMI remoting extension points to propagate
the <code>ContextHolder</code> (which should contain an
<code>Authentication</code> request token)
from one JVM to the remote JVM.
<P>The beans are wired as follows:
<P>
<code>
&lt;bean id="test" class="org.springframework.remoting.rmi.RmiProxyFactoryBean"&gt;<BR>
&lt;property name="serviceUrl"&gt;&lt;value&gt;rmi://localhost/Test&lt;/value&gt;&lt;/property&gt;<BR>
&lt;property name="serviceInterface"&gt;&lt;value&gt;test.TargetInterface&lt;/value&gt;&lt;/property&gt;<BR>
&lt;property name="refreshStubOnConnectFailure"&gt;&lt;value&gt;true&lt;/value&gt;&lt;/property&gt;<BR>
&lt;property name="remoteInvocationFactory"&gt;&lt;ref bean="remoteInvocationFactory"/&gt;&lt;/property&gt;<BR>
&lt;/bean&gt;<BR>
<BR>
&lt;bean id="remoteInvocationFactory" class="org.springframework.security.core.context.rmi.ContextPropagatingRemoteInvocationFactory"/&gt;<BR>
</code>
</body>
</html>
@@ -0,0 +1,7 @@
/**
* General utility classes used throughout the Spring Security framework. Intended for internal use.
* <p>
* This package should be standalone - it should not have dependencies on other parts of the framework,
* just on external libraries and the JDK.
*/
package org.springframework.security.util;
@@ -1,11 +0,0 @@
<html>
<body>
<p>
General utility classes used throughout the Spring Security framework.
</p>
<p>
This package should essentially be standalone - it should not have dependencies on other
parts of the framework, just on external libraries and the JDK.
</p>
</body>
</html>