Skip to content

O
Openfire
Commit 36ebfaf5 authored by Christian Schudt's avatar Christian Schudt
Browse files
Options

OF-744 Replace package.html with package-info.java

parent f5a475b6
Hide whitespace changes
Inline Side-by-side
Showing with 169 additions and 275 deletions
src/java/org/jivesoftware/admin/package-info.java 0 → 100644
View file @ 36ebfaf5
/**
* Supporting classes and tags for the admin console.
*/
package org.jivesoftware.admin;
\ No newline at end of file
src/java/org/jivesoftware/admin/package.html deleted 100644 → 0
View file @ f5a475b6
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
</head>
<body>
<p>Supporting classes and tags for the admin console.</p>
</body>
</html>
src/java/org/jivesoftware/database/package-info.java 0 → 100644
View file @ 36ebfaf5
/**
* Database connection code.
*/
package org.jivesoftware.database;
\ No newline at end of file
src/java/org/jivesoftware/database/package.html deleted 100644 → 0
View file @ f5a475b6
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
</head>
<body>
<p>Database connection code.</p>
</body>
</html>
src/java/org/jivesoftware/openfire/audit/package-info.java 0 → 100644
View file @ 36ebfaf5
/**
* Service that records XMPP traffics.
*/
package org.jivesoftware.openfire.audit;
\ No newline at end of file
src/java/org/jivesoftware/openfire/audit/package.html deleted 100644 → 0
View file @ f5a475b6
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
</head>
<body>
<p>Service that records XMPP traffic.</p>
</body>
</html>
src/java/org/jivesoftware/openfire/auth/package-info.java 0 → 100644
View file @ 36ebfaf5
/**
* Authentication and Authorization service interfaces and classes. There are three components:
*
* <ul>
* <li><b>Authentication</b>. Authentication is the process of verifying a user. Custom authentication implementations can be created by extending the {@link org.jivesoftware.openfire.auth.AuthProvider} interface.</li>
* <li><b>Authorization</b>. Authorization is the process of allowing an authenticated identity to choose a username. Default authorization will authorize an authenticated username to the same username only. Custom authorization implementations can be created by extending the {@link org.jivesoftware.openfire.auth.AuthorizationPolicy} interface.</li>
* <li><b>Authorization Mapping</b>. Mapping occurs when the client did not request any specific username. This provides a method of giving a default username in these situations. Custom authorization mappings can be created by extending the {@link org.jivesoftware.openfire.auth.AuthorizationMapping} interface.</li>
* </ul>
*/
package org.jivesoftware.openfire.auth;
\ No newline at end of file
src/java/org/jivesoftware/openfire/auth/package.html deleted 100644 → 0
View file @ f5a475b6
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
</head>
<body>
<p>Authentication and Authorization service interfaces and classes. There are three compoents:
<ul>
<li><b>Authentication</b>. Authentication is the process of verifying a user. Custom authentication implementations can be created by extending the {@link org.jivesoftware.openfire.auth.AuthProvider} interface.</li>
<li><b>Authorization</b>. Authorization is the process of allowing an authenticated identity to choose a username. Default authorization will authorize an authenticated username to the same username only. Custom authorization implementations can be created by extending the {@link org.jivesoftware.openfire.auth.AuthorizationPolicy} interface.</li>
<li><b>Authorization Mapping</b>. Mapping occurs when the client did not request any specific username. This provides a method of giving a default username in these situations. Custom authorization mappings can be created by extending the {@link org.jivesoftware.openfire.auth.AuthorizationMapping} interface.</li>
</ul>
</body>
</html>
src/java/org/jivesoftware/openfire/commands/package-info.java 0 → 100644
View file @ 36ebfaf5
/**
* Ad-Hoc Commands implementation (XEP-0050).
*/
package org.jivesoftware.openfire.commands;
\ No newline at end of file
src/java/org/jivesoftware/openfire/commands/package.html deleted 100644 → 0
View file @ f5a475b6
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
</head>
<body>
<p>Ad-Hoc Commands implementation (JEP-0050).</p>
</body>
</html>
src/java/org/jivesoftware/openfire/container/package-info.java 0 → 100644
View file @ 36ebfaf5
/**
* <p>The microkernel core of the server is a simple, flexible, nested
* container framework defined in this package. </p>
* <p> The container model consists of&nbsp; three primary participants:<br>
* </p>
* <ul>
* <li><strong>Service</strong> - A well-known Java object defined by a
* Java interface. Code running in the server should be organized into
* services that perform logical (and limited) blocks of work. These
* services can then be exposed as a Java interface and obtained using the
* ServiceLookup service. Although most services will be local to the
* container, some may use RMI, web services, XMPP, or other remote
* procedure call technologies to provide services across the network.<br>
* </li>
* <li><strong>Module </strong>- The smallest server deployment unit. A
* module has a well-defined life cycle that is managed by its hosting
* container. A module may contain zero or more services and client code
* that accesses these services. Modules can be deployed and configured
* individually, allowing the easy implementation of server plugins and
* on the fly reconfiguration of the server.<br>
* </li>
* <li><strong>Container </strong>- A special module that hosts server
* modules including other containers. Hosting involves life cycle
* management of child modules, configuration of child modules, and
* providing access to shared resources. Containers also provide their own
* configurable security managers and custom classloaders that extend the
* classpath to automatically include module classes and jar files located
* in well defined locations (e.g. similar to WEB-INF/lib and
* WEB-INF/classes in a J2EE web-app/WAR).</li>
* </ul>
* <p>The nesting nature of containers allows a tree-like server
* architecture with a root 'bootstrap container' with core modules, and
* child containers with their own modules. Child containers by default
* inherit and extend the bootstrap container's classpath and services
* while being protected from implementation details of any modules,
* containers, or services in layers above them. In some cases, child
* containers may have restricted views or access to upper levels of the
* tree (e.g. a user plug-in container that allows users to add arbitrary
* server extensions).<br>
* </p>
*/
package org.jivesoftware.openfire.container;
\ No newline at end of file
src/java/org/jivesoftware/openfire/container/package.html deleted 100644 → 0
View file @ f5a475b6
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
</head>
<body>
<p>The microkernel core of the server is a simple, flexible, nested
container framework defined in this package. </p>
<p> The container model consists of&nbsp; three primary participants:<br>
</p>
<ul>
<li><strong>Service</strong> - A well-known Java object defined by a
Java interface. Code running in the server should be organized into
services that perform logical (and limited) blocks of work. These
services can then be exposed as a Java interface and obtained using the
ServiceLookup service. Although most services will be local to the
container, some may use RMI, web services, XMPP, or other remote
procedure call technologies to provide services across the network.<br>
</li>
<li><strong>Module </strong>- The smallest server deployment unit. A
module has a well-defined life cycle that is managed by its hosting
container. A module may contain zero or more services and client code
that accesses these services. Modules can be deployed and configured
individually, allowing the easy implementation of server plugins and
on the fly reconfiguration of the server.<br>
</li>
<li><strong>Container </strong>- A special module that hosts server
modules including other containers. Hosting involves life cycle
management of child modules, configuration of child modules, and
providing access to shared resources. Containers also provide their own
configurable security managers and custom classloaders that extend the
classpath to automatically include module classes and jar files located
in well defined locations (e.g. similar to WEB-INF/lib and
WEB-INF/classes in a J2EE web-app/WAR).</li>
</ul>
<p>The nesting nature of containers allows a tree-like server
architecture with a root 'bootstrap container' with core modules, and
child containers with their own modules. Child containers by default
inherit and extend the bootstrap container's classpath and services
while being protected from implementation details of any modules,
containers, or services in layers above them. In some cases, child
containers may have restricted views or access to upper levels of the
tree (e.g. a user plug-in container that allows users to add arbitrary
server extensions).<br>
</p>
</body>
</html>
src/java/org/jivesoftware/openfire/disco/package-info.java 0 → 100644
View file @ 36ebfaf5
/**
* Service discovery implementation (XEP-0030).
*/
package org.jivesoftware.openfire.disco;
\ No newline at end of file
src/java/org/jivesoftware/openfire/disco/package.html deleted 100644 → 0
View file @ f5a475b6
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
</head>
<body>
<p>Service discovery implementation (JEP-0030).</p>
</body>
</html>
src/java/org/jivesoftware/openfire/entitycaps/package-info.java 0 → 100644
View file @ 36ebfaf5
/**
* Implementation of Entity Capabilities (XEP-0115).
*/
package org.jivesoftware.openfire.entitycaps;
\ No newline at end of file
src/java/org/jivesoftware/openfire/entitycaps/package.html deleted 100644 → 0
View file @ f5a475b6
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
</head>
<body>
<p>Implementation of Entity Capabilities (XEP-0115).</p>
</body>
</html>
src/java/org/jivesoftware/openfire/event/package-info.java 0 → 100644
View file @ 36ebfaf5
/**
* Event system.
*/
package org.jivesoftware.openfire.event;
\ No newline at end of file
src/java/org/jivesoftware/openfire/event/package.html deleted 100644 → 0
View file @ f5a475b6
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
</head>
<body>
<p>Event system.</p>
</body>
</html>
src/java/org/jivesoftware/openfire/filetransfer/package-info.java 0 → 100644
View file @ 36ebfaf5
/**
* Implementation of SOCKS5 Bytestreams (XEP-0065).
*/
package org.jivesoftware.openfire.filetransfer;
\ No newline at end of file
src/java/org/jivesoftware/openfire/filetransfer/package.html deleted 100644 → 0
View file @ f5a475b6
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
</head>
<body>
<p>Implementation of SOCKS5 Bytestreams (JEP-0065).</p>
</body>
</html>
src/java/org/jivesoftware/openfire/forms/package-info.java 0 → 100644
View file @ 36ebfaf5
/**
* Data forms implementation (XEP-0004).
*/
package org.jivesoftware.openfire.forms;
\ No newline at end of file
src/java/org/jivesoftware/openfire/forms/package.html deleted 100644 → 0
View file @ f5a475b6
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
</head>
<body>
<p>Data forms implementation (JEP-0004).</p>
</body>
</html>
src/java/org/jivesoftware/openfire/group/package-info.java 0 → 100644
View file @ 36ebfaf5
/**
* Groups, which are used to organize users together.
*/
package org.jivesoftware.openfire.group;
\ No newline at end of file
src/java/org/jivesoftware/openfire/group/package.html deleted 100644 → 0
View file @ f5a475b6
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
</head>
<body>
<p>Groups, which are used to organize users together.</p>
</body>
</html>
src/java/org/jivesoftware/openfire/handler/package-info.java 0 → 100644
View file @ 36ebfaf5
/**
* IQ class implementations.
*/
package org.jivesoftware.openfire.handler;
\ No newline at end of file
src/java/org/jivesoftware/openfire/handler/package.html deleted 100644 → 0
View file @ f5a475b6
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
</head>
<body>
<p>IQ class implementations.</p>
</body>
</html>
src/java/org/jivesoftware/openfire/launcher/package-info.java 0 → 100644
View file @ 36ebfaf5
/**
* Laucher classes for Openfire.
*/
package org.jivesoftware.openfire.launcher;
\ No newline at end of file
src/java/org/jivesoftware/openfire/launcher/package.html deleted 100644 → 0
View file @ f5a475b6
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
</head>
<body>
<p>Laucher classes for Openfire.</p>
</body>
</html>
src/java/org/jivesoftware/openfire/ldap/package-info.java 0 → 100644
View file @ 36ebfaf5
/**
* LDAP code for authentication and user profile information.
*/
package org.jivesoftware.openfire.ldap;
\ No newline at end of file
src/java/org/jivesoftware/openfire/ldap/package.html deleted 100644 → 0
View file @ f5a475b6
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
</head>
<body>
<p>LDAP code for authentication and user profile information.</p>
</body>
</html>
src/java/org/jivesoftware/openfire/muc/package-info.java 0 → 100644
View file @ 36ebfaf5
/**
* Implementation of Multi-User Chat (XEP-0045).
*/
package org.jivesoftware.openfire.muc;
\ No newline at end of file
src/java/org/jivesoftware/openfire/muc/package.html deleted 100644 → 0
View file @ f5a475b6
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
</head>
<body>
<p>Implementation of Multi-User Chat (JEP-0045).</p>
</body>
</html>
src/java/org/jivesoftware/openfire/muc/spi/package-info.java 0 → 100644
View file @ 36ebfaf5
/**
* Implementation of Multi-User Chat (XEP-0045).
*/
package org.jivesoftware.openfire.muc.spi;
\ No newline at end of file
src/java/org/jivesoftware/openfire/muc/spi/package.html deleted 100644 → 0
View file @ f5a475b6
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
</head>
<body>
<p>Implementation of Multi-User Chat (JEP-0045).</p>
</body>
</html>
src/java/org/jivesoftware/openfire/multiplex/package-info.java 0 → 100644
View file @ 36ebfaf5
/**
* Connection Manager implementation. Connection Managers architecture is composed of two parties.
* <ul>
* <li>Connection Managers that accept client connections. Not implemented here.</li>
* <li>The Main server that handles Connection Manager connections. Implemented here.</li>
* </ul>
*/
package org.jivesoftware.openfire.multiplex;
\ No newline at end of file
src/java/org/jivesoftware/openfire/multiplex/package.html deleted 100644 → 0
View file @ f5a475b6
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
</head>
<body>
<p>Connection Manager implementation. Connection Managers architecture is composed of two parties.
<ul>
<li>Connection Managers that accept client connections. Not implemented here.</li>
<li>The Main server that handles Connection Manager connections. Implemented here.</li>
</ul>
</p>
</body>
</html>
src/java/org/jivesoftware/openfire/pep/package-info.java 0 → 100644
View file @ 36ebfaf5
/**
* Implementation of Personal Eventing via Pubsub (XEP-0163).
*/
package org.jivesoftware.openfire.pep;
\ No newline at end of file
src/java/org/jivesoftware/openfire/pep/package.html deleted 100644 → 0
View file @ f5a475b6
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
</head>
<body>
<p>Implementation of Personal Eventing via Pubsub (XEP-0163).</p>
</body>
</html>
src/java/org/jivesoftware/openfire/privacy/package-info.java 0 → 100644
View file @ 36ebfaf5
/**
* Implementation of Blocking Communication.
*/
package org.jivesoftware.openfire.privacy;
\ No newline at end of file
src/java/org/jivesoftware/openfire/privacy/package.html deleted 100644 → 0
View file @ f5a475b6
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
</head>
<body>
<p>Implementation of Blocking Communication.</p>
</body>
</html>
src/java/org/jivesoftware/openfire/pubsub/models/package-info.java 0 → 100644
View file @ 36ebfaf5
/**
* Defines policies that define who is allowed to subscribe and retrieve items or policies that
* define who is allowed to publish items to nodes (XEP-0060).
*/
package org.jivesoftware.openfire.pubsub.models;
\ No newline at end of file
src/java/org/jivesoftware/openfire/pubsub/models/package.html deleted 100644 → 0
View file @ f5a475b6
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
</head>
<body>
<p>Defines policies that define who is allowed to subscribe and retrieve items or policies that
define who is allowed to publish items to nodes. (JEP-0060).</p>
</body>
</html>
src/java/org/jivesoftware/openfire/pubsub/package-info.java 0 → 100644
View file @ 36ebfaf5
/**
* Implementation of Publish-Subscribe (XEP-0060).
*/
package org.jivesoftware.openfire.pubsub;
\ No newline at end of file
src/java/org/jivesoftware/openfire/pubsub/package.html deleted 100644 → 0
View file @ f5a475b6
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
</head>
<body>
<p>Implementation of Publish-Subscribe (JEP-0060).</p>
</body>
</html>
src/java/org/jivesoftware/openfire/server/package-info.java 0 → 100644
View file @ 36ebfaf5
/**
* Classes used for server-to-server communication.
*/
package org.jivesoftware.openfire.server;
\ No newline at end of file
src/java/org/jivesoftware/openfire/server/package.html deleted 100644 → 0
View file @ f5a475b6
!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
</head>
<body>
<p>Classes used for server-to-server communication.</p>
</body>
</html>
\ No newline at end of file
src/java/org/jivesoftware/openfire/update/package-info.java 0 → 100644
View file @ 36ebfaf5
/**
* Classes that provide the "check for update" service or the "get available plugins" service.
*/
package org.jivesoftware.openfire.update;
\ No newline at end of file
src/java/org/jivesoftware/openfire/update/package.html deleted 100644 → 0
View file @ f5a475b6
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
</head>
<body>
<p>Classes that provide the "check for update" service or the "get available plugins" service.</p>
</body>
</html>
src/java/org/jivesoftware/openfire/user/package-info.java 0 → 100644
View file @ 36ebfaf5
/**
* <p>Provides the interfaces and classes necessary to create custom
* user account data providers for Openfire.</p>
* <p>User accounts are handled separately from authentication. The three
* primary interfaces to implement are the UserIDProvider,
* UserAccountProvider, and UserInfoProvider. An overview of how these
* providers should be implemented and how they interact is described in
* the User Account Provider Guide included in the Openfire distribution.</p>
* <p>There are several Roster (a.k.a. Buddy List) related classes in the
* user package. Developers are strongly discouraged from implementing
* custom RosterProvider classes. Roster provider implementation is
* complicated and should be left to the Jive JDBC implementation if at
* all possible. There are no disadvantages in implementing user account
* data with custom providers to integrate Openfire with a CRM or ERP
* user system, while leaving roster storage in Jive's standard JDBC
* database tables. (Note: Openfire comes with JDBC and LDAP user account
* providers 'out of the box'. It is expected that LDAP will accomodate
* many enterprise integration needs).</p>
*/
package org.jivesoftware.openfire.user;
\ No newline at end of file
src/java/org/jivesoftware/openfire/user/package.html deleted 100644 → 0
View file @ f5a475b6
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
</head>
<body>
<p>Provides the interfaces and classes necessary to create custom
user account data providers for Openfire.</p>
<p>User accounts are handled separately from authentication. The three
primary interfaces to implement are the UserIDProvider,
UserAccountProvider, and UserInfoProvider. An overview of how these
providers should be implemented and how they interact is described in
the User Account Provider Guide included in the Openfire distribution.</p>
<p>There are several Roster (a.k.a. Buddy List) related classes in the
user package. Developers are strongly discouraged from implementing
custom RosterProvider classes. Roster provider implementation is
complicated and should be left to the Jive JDBC implementation if at
all possible. There are no disadvantages in implementing user account
data with custom providers to integrate Openfire with a CRM or ERP
user system, while leaving roster storage in Jive's standard JDBC
database tables. (Note: Openfire comes with JDBC and LDAP user account
providers 'out of the box'. It is expected that LDAP will accomodate
many enterprise integration needs).</p>
</body>
</html>
src/java/org/jivesoftware/util/package-info.java 0 → 100644
View file @ 36ebfaf5
/**
* Utility classes.
*/
package org.jivesoftware.util;
\ No newline at end of file
src/java/org/jivesoftware/util/package.html deleted 100644 → 0
View file @ f5a475b6
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
</head>
<body>
<p>Utility classes.</p>
</body>
</html>
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment

Technounit-GROUP 2023