public boolean isSecure();
/**
+ * Sets the maximum age.
*
- * @param maxAge
+ * @param MaxAge the maximum age to set
* @throws IllegalStateException
*/
public void setMaxAge(int MaxAge);
}
/**
- * @param classLoader The classLoader to set.
+ * @param classLoaderName The classLoader to set.
*/
public void setClassLoader(String classLoaderName) {
this.classLoader = classLoaderName;
/**
- * Invoke the next filter in this chain, passing the specified request
- * and response. If there are no more filters in this chain, invoke
- * the <code>service()</code> method of the servlet itself.
- *
- * @param request The servlet request we are processing
- * @param response The servlet response we are creating
- *
+ * Process the event, using the security manager if the option is enabled.
+ *
+ * @param event the event to process
+ *
* @exception IOException if an input/output error occurs
* @exception ServletException if a servlet exception occurs
*/
*
* @param request Request to be processed
* @param response Response to be produced
- * @param valveContext Valve context used to forward to the next Valve
*
* @exception IOException if an input/output error occurred
* @exception ServletException if a servlet error occurred
*
* @param request Request to be processed
* @param response Response to be produced
- * @param valveContext Valve context used to forward to the next Valve
+ * @param event
*
* @exception IOException if an input/output error occurred
* @exception ServletException if a servlet error occurred
*
* @param request Request to be processed
* @param response Response to be produced
- * @param valveContext Valve context used to forward to the next Valve
*
* @exception IOException if an input/output error occurred
* @exception ServletException if a servlet error occurred
*
* @param request Request to be processed
* @param response Response to be produced
- * @param valveContext Valve context used to forward to the next Valve
+ * @param event the event
*
* @exception IOException if an input/output error occurred
* @exception ServletException if a servlet error occurred
*
* @param request Request to be processed
* @param response Response to be produced
- * @param valveContext Valve context used to forward to the next Valve
*
* @exception IOException if an input/output error occurred
* @exception ServletException if a servlet error occurred
*
* @param request Request to be processed
* @param response Response to be produced
- * @param valveContext Valve context used to forward to the next Valve
+ * @param event the event
*
* @exception IOException if an input/output error occurred
* @exception ServletException if a servlet error occurred
*
* @param request Request to be processed
* @param response Response to be produced
- * @param valveContext Valve context used to forward to the next Valve
*
* @exception IOException if an input/output error occurred
* @exception ServletException if a servlet error occurred
public boolean doDomainReplication();
/**
- * @param sendClusterDomainOnly Flag value.
+ * @param domainReplication Flag value.
* @since 5.5.10
*/
public void setDomainReplication(boolean domainReplication);
// ----------------------------------------------------------- Constructors
+ public DeltaSession() {
+ this(null);
+ }
+
/**
* Construct a new Session associated with the specified Manager.
*
* @param manager
* The manager with which this Session is associated
*/
- public DeltaSession() {
- this(null);
- }
-
public DeltaSession(Manager manager) {
super(manager);
this.resetDeltaRequest();
* notify all listeners from receiving a new message is not ClusterMessage
* emit Failure Event to LifecylceListener
*
- * @param message
+ * @param msg
* received Message
*/
public boolean accept(Serializable msg, Member sender) {
package org.apache.catalina.manager;
-import java.io.IOException;
import java.io.PrintWriter;
import java.lang.reflect.Method;
import java.text.MessageFormat;
import javax.management.MBeanServer;
import javax.management.ObjectInstance;
import javax.management.ObjectName;
-import javax.servlet.ServletException;
import javax.servlet.http.HttpServletResponse;
import org.apache.catalina.util.RequestUtil;
/**
- * Process a GET request for the specified resource.
+ * Write an HTML or XML header.
*
- * @param request The servlet request we are processing
- * @param response The servlet response we are creating
+ * @param writer the PrintWriter to use
+ * @param mode - 0 = HTML header, 1 = XML declaration
*
- * @exception IOException if an input/output error occurs
- * @exception ServletException if a servlet-specified error occurs
*/
public static void writeHeader(PrintWriter writer, int mode) {
if (mode == 0){
*
* @param username Username of the Principal to look up
* @param clientDigest Digest which has been submitted by the client
- * @param nOnce Unique (or supposedly unique) token which has been used
+ * @param nonce Unique (or supposedly unique) token which has been used
* for this request
- * @param realm Realm name
+ * @param realmName Realm name
* @param md5a2 Second MD5 digest used to calculate the digest :
* MD5(Method + ":" + uri)
*/
@Override
public Principal authenticate(String username, String clientDigest,
- String once, String nc, String cnonce, String qop,
+ String nonce, String nc, String cnonce, String qop,
String realmName, String md5a2) {
Principal authenticatedUser = null;
log.debug(sm.getString("combinedRealm.authStart", username, realm.getInfo()));
}
- authenticatedUser = realm.authenticate(username, clientDigest, once,
+ authenticatedUser = realm.authenticate(username, clientDigest, nonce,
nc, cnonce, qop, realmName, md5a2);
if (authenticatedUser == null) {
*
* @param username Username of the Principal to look up
* @param clientDigest Digest which has been submitted by the client
- * @param nOnce Unique (or supposedly unique) token which has been used
+ * @param nonce Unique (or supposedly unique) token which has been used
* for this request
- * @param realm Realm name
+ * @param realmName Realm name
* @param md5a2 Second MD5 digest used to calculate the digest :
* MD5(Method + ":" + uri)
*/
@Override
public Principal authenticate(String username, String clientDigest,
- String once, String nc, String cnonce, String qop,
+ String nonce, String nc, String cnonce, String qop,
String realmName, String md5a2) {
if (isLocked(username)) {
}
Principal authenticatedUser = super.authenticate(username, clientDigest,
- once, nc, cnonce, qop, realmName, md5a2);
+ nonce, nc, cnonce, qop, realmName, md5a2);
if (authenticatedUser == null) {
registerAuthFailure(username);
/**
- * Enables or disables naming support.
+ * Enables or disables redirection.
*
- * @param useNaming The new use naming value
+ * @param redirectStreams The new redirection value
*/
public void setRedirectStreams(boolean redirectStreams) {
* no namespace
* @param name the local name if the parser is namespace aware, or just
* the element name otherwise
- * @param bodyText The body text of this element
+ * @param text The body text of this element
*/
@Override
public void body(String namespace, String name, String text)
* no namespace
* @param name the local name if the parser is namespace aware, or just
* the element name otherwise
- * @param bodyText The body text of this element
+ * @param text The body text of this element
*/
@Override
public void body(String namespace, String name, String text)
* Send a message to one or more members in the cluster
* @param destination Member[] - the destinations, null or zero length means all
* @param msg ClusterMessage - the message to send
- * @param options int - sender options, see class documentation
- * @return ClusterMessage[] - the replies from the members, if any.
+ * @param payload TBA
*/
@Override
public void sendMessage(Member[] destination, ChannelMessage msg, InterceptorPayload payload) throws ChannelException {
return options;
}
/**
- * @param sets the message options
+ * Sets the message options.
+ *
+ * @param options the message options
*/
public void setOptions(int options) {
this.options = options;
/**
* Deserializes a ChannelData object from a byte array
- * @param b byte[]
+ * @param xbuf byte[]
* @return ChannelData
*/
public static ChannelData getDataFromPackage(XByteBuffer xbuf) {
* Append new bytes to buffer.
* @see XByteBuffer#countPackages()
* @param data new transfer buffer
- * @param off offset
* @param len length in buffer
- * @return number of messages that was sent to callback
+ * @param count whether to return the count
+ * @return number of messages that was sent to callback (or -1 if count == false)
* @throws java.io.IOException
*/
public int append(ByteBuffer data, int len, boolean count) throws java.io.IOException {
* Construct a new instance of CustomObjectInputStream
*
* @param stream The input stream we will read from
- * @param classLoader The class loader used to instantiate objects
+ * @param classLoaders The class loader array used to instantiate objects
*
* @exception IOException if an input/output error occurs
*/
* Appends the data to the buffer. If the data is incorrectly formatted, ie, the data should always start with the
* header, false will be returned and the data will be discarded.
* @param b - bytes to be appended
- * @param off - the offset to extract data from
* @param len - the number of bytes to append.
* @return true if the data was appended correctly. Returns false if the package is incorrect, ie missing header or something, or the length of data is 0
*/
/**
* Creates a complete data package
- * @param indata - the message data to be contained within the package
- * @param compressed - compression flag for the indata buffer
+ * @param cdata - the message data to be contained within the package
* @return - a full package (header,size,data,footer)
*
*/
/**
- * Converts an integer to four bytes
- * @param n - the integer
- * @return - four bytes in an array
+ * Converts a boolean to a 1-byte array
+ * @param bool - the integer
+ * @return - 1-byte array
* @deprecated use toBytes(boolean,byte[],int)
*/
@Deprecated
return data;
}
- /**
- *
- * @param <any> long
- * @return use
- */
public static boolean toBoolean(byte[] b, int offset) {
return b[offset] != 0;
}
/**
* Serializes a message into cluster data
* @param msg ClusterMessage
- * @param compress boolean
- * @return
+ * @return serialized content as byte[] array
* @throws IOException
*/
public static byte[] serialize(Serializable msg) throws IOException {
* @param bind - the bind address (not sure this is used yet)
* @param mcastAddress - the mcast address
* @param service - the callback service
- * @param disableLoopbackMode - disable loopbackMode
+ * @param localLoopbackDisabled - disable loopbackMode
* @throws IOException
*/
public McastServiceImpl(
/**
* Send a ping
- * @throws Exception
+ * @throws IOException
*/
public void send(boolean checkexpired) throws IOException{
send(checkexpired,null);
*/
protected int msgCount = 0;
/**
- * The number of milliseconds since this members was
+ * The number of milliseconds since this member was
* created, is kept track of using the start time
*/
protected long memberAliveTime = 0;
/**
* Construct a new member object
- * @param name - the name of this member, cluster unique
- * @param domain - the cluster domain name of this member
* @param host - the tcp listen host
* @param port - the tcp listen port
+ * @param aliveTime - the number of milliseconds since this member was created
*/
public MemberImpl(String host,
int port,
* Create a data package to send over the wire representing this member.
* This is faster than serialization.
* @return - the bytes for this member deserialized
- * @throws Exception
*/
public byte[] getData() {
return getData(true);
/**
* Constructs a new membership
- * @param name - has to be the name of the local member. Used to filter the local member from the cluster membership
+ * @param local - has to be the name of the local member. Used to filter the local member from the cluster membership
+ * @param includeLocal - TBA
*/
public Membership(MemberImpl local, boolean includeLocal) {
this.local = local;
* Construct a new element from the data object.
* Sets the pointer to null.
*
- * @param key The key
+ * @param msg the message
+ * @param destination TBA
* @param payload The data object.
*/
public LinkObject(ChannelMessage msg, Member[] destination, InterceptorPayload payload) {
/**
* start cluster receiver
- * @throws Exception
+ * @throws IOException
* @see org.apache.catalina.tribes.ClusterReceiver#start()
*/
@Override
/**
* Setting the readonly status of the user database
*
- * @param pathname The new pathname
+ * @param readonly the new status
*/
public void setReadonly(boolean readonly) {
* Default value : <code>X-Forwarded-For</code>
* </p>
*
- * @param remoteIPHeader
+ * @param remoteIpHeader
*/
public void setRemoteIpHeader(String remoteIpHeader) {
this.remoteIpHeader = remoteIpHeader;
/**
* <p>
- * Comma delimited list of proxies that are trusted when they appear in the {@link #remoteIPHeader} header. Can be expressed as a
+ * Comma delimited list of proxies that are trusted when they appear in the {@link #remoteIpHeader} header. Can be expressed as a
* regular expression.
* </p>
* <p>
/**
* Process pipelined HTTP requests on the specified socket.
*
- * @param socket Socket from which the HTTP requests will be read
+ * @param socketWrapper Socket from which the HTTP requests will be read
* and the HTTP responses will be written.
*
* @throws IOException error during an I/O operation
*
* @param inFileName The path to the resource to be included.
* @param parent The parent node of the include directive.
- * @param jarFile The JAR file from which to read the included resource,
+ * @param jarFileUrl The JAR file from which to read the included resource,
* or null of the included resource is to be read from the filesystem
*/
public Node.Nodes parse(String inFileName, Node parent,
* the current ParserController used in this compilation
* @param name
* the tag name as specified in the TLD
- * @param tagfile
+ * @param path
* the path for the tagfile
* @param tagFileJarUrl
* the url for the Jar containign the tag file
*
* @param ctxt the servlet context of the web application in which Jasper
* is running
- * @param redeployMode if true, then the compiler will allow redeploying
- * a tag library from the same jar, at the expense of slowing down the
- * server a bit. Note that this may only work on JDK 1.3.1_01a and later,
- * because of JDK bug 4211817 fixed in this release.
- * If redeployMode is false, a faster but less capable mode will be used.
*/
public TldLocationsCache(ServletContext ctxt) {
this.ctxt = ctxt;
// ----------------------------------------------------------- Constructors
- /**
- * Service Reference.
- *
- * @param serviceClass Service class
- */
public HandlerRef(String refname, String handlerClass) {
this(refname, handlerClass, null, null);
}
- /**
- * Service Reference.
- *
- * @param serviceClass Service class
- */
public HandlerRef(String refname, String handlerClass,
String factory, String factoryLocation) {
super(refname, factory, factoryLocation);
// ----------------------------------------------------------- Constructors
-
- /**
- * Service Reference.
- *
- * @param serviceClass Service class
- */
public ServiceRef(String refname, String serviceInterface, String[] serviceQname,
String wsdl, String jaxrpcmapping) {
this(refname, serviceInterface, serviceQname, wsdl, jaxrpcmapping,
null, null);
}
-
- /**
- * Service Reference.
- *
- * @param serviceClass Service class
- */
public ServiceRef(String refname, String serviceInterface, String[] serviceQname,
String wsdl, String jaxrpcmapping,
String factory, String factoryLocation) {
* Return the real path for a given virtual path, if possible; otherwise
* return <code>null</code>.
*
- * @param path The path to the desired resource
+ * @param name The path to the desired resource
*/
public String getRealPath(String name) {
if (!aliases.isEmpty()) {
/**
* Sets the files to be converted into HTML
*
- * @param fileset The fileset to be converted.
+ * @param fs The fileset to be converted.
*/
public void addFileset( FileSet fs ) {
filesets.add( fs );
/**
* Perform the conversion
*
- * @param BuildException Thrown if an error occurs during execution of
+ * @throws BuildException if an error occurs during execution of
* this task.
*/
@Override
* @param namespace the namespace URI of the matching element, or an
* empty string if the parser is not namespace aware or the element has
* no namespace
- * @param name the local name if the parser is namespace aware, or just
+ * @param theName the local name if the parser is namespace aware, or just
* the element name otherwise
* @param attributes The attribute list for this element
*/
* @param namespace the namespace URI of the matching element, or an
* empty string if the parser is not namespace aware or the element has
* no namespace
- * @param name the local name if the parser is namespace aware, or just
+ * @param theName the local name if the parser is namespace aware, or just
* the element name otherwise
* @param attributes The attribute list for this element
*
// ------------------------------------------------ PersistentMBean Methods
- /**
- * Instantiates this MBean instance from data found in the persistent
- * store. The data loaded could include attribute and operation values.
- * This method should be called during construction or initialization
- * of the instance, and before the MBean is registered with the
- * <code>MBeanServer</code>.
- *
- * <p><strong>IMPLEMENTATION NOTE</strong> - This implementation does
- * not support persistence.</p>
- *
- * @exception InstanceNotFoundException if the managed resource object
- * cannot be found
- * @exception MBeanException if the initializer of the object throws
- * an exception
- * @exception RuntimeOperationsException if an exception is reported
- * by the persistence mechanism
- */
+// /**
+// * Instantiates this MBean instance from data found in the persistent
+// * store. The data loaded could include attribute and operation values.
+// * This method should be called during construction or initialization
+// * of the instance, and before the MBean is registered with the
+// * <code>MBeanServer</code>.
+// *
+
// * <p><strong>IMPLEMENTATION NOTE</strong> - This implementation does
+// * not support persistence.</p>
+// *
+// * @exception InstanceNotFoundException if the managed resource object
+// * cannot be found
+// * @exception MBeanException if the initializer of the object throws
+// * an exception
+// * @exception RuntimeOperationsException if an exception is reported
+// * by the persistence mechanism
+// */
// public void load() throws InstanceNotFoundException,
// MBeanException, RuntimeOperationsException {
// // XXX If a context was set, use it to load the data
// }
- /**
- * Capture the current state of this MBean instance and write it out
- * to the persistent store. The state stored could include attribute
- * and operation values. If one of these methods of persistence is not
- * supported, a "service not found" exception will be thrown.
- *
- * <p><strong>IMPLEMENTATION NOTE</strong> - This implementation does
- * not support persistence.</p>
- *
- * @exception InstanceNotFoundException if the managed resource object
- * cannot be found
- * @exception MBeanException if the initializer of the object throws
- * an exception, or persistence is not supported
- * @exception RuntimeOperationsException if an exception is reported
- * by the persistence mechanism
- */
+// /**
+// * Capture the current state of this MBean instance and write it out
+// * to the persistent store. The state stored could include attribute
+// * and operation values. If one of these methods of persistence is not
+// * supported, a "service not found" exception will be thrown.
+// *
+
// * <p><strong>IMPLEMENTATION NOTE</strong> - This implementation does
+// * not support persistence.</p>
+// *
+// * @exception InstanceNotFoundException if the managed resource object
+// * cannot be found
+// * @exception MBeanException if the initializer of the object throws
+// * an exception, or persistence is not supported
+// * @exception RuntimeOperationsException if an exception is reported
+// * by the persistence mechanism
+// */
// public void store() throws InstanceNotFoundException,
// MBeanException, RuntimeOperationsException {
//
// -------------------- BaseModelMBean methods --------------------
- /** Set the type of the mbean. This is used as a key to locate
- * the description in the Registry.
- *
- * @param type the type of classname of the modeled object
- */
+// /** Set the type of the mbean. This is used as a key to locate
+// * the description in the Registry.
+// *
+// * @param type the type of classname of the modeled object
+// */
// void setModeledType( String type ) {
// initModelInfo(type);
// createResource();
// }
- /** Set the type of the mbean. This is used as a key to locate
- * the description in the Registry.
- *
- * @param type the type of classname of the modeled object
- */
+// /** Set the type of the mbean. This is used as a key to locate
+// * the description in the Registry.
+// *
+// * @param type the type of classname of the modeled object
+// */
// void initModelInfo( String type ) {
// try {
// if( log.isDebugEnabled())
// }
// }
- /** Set the type of the mbean. This is used as a key to locate
- * the description in the Registry.
- */
+// /** Set the type of the mbean. This is used as a key to locate
+// * the description in the Registry.
+// */
// protected void createResource() {
// try {
// //Thread.currentThread().setContextClassLoader(BaseModelMBean.class.getClassLoader());
// ------------------------------------------------------ Protected Methods
- /**
- * Create and return a default <code>ModelMBeanInfo</code> object.
- */
+// /**
+// * Create and return a default <code>ModelMBeanInfo</code> object.
+// */
// protected ModelMBeanInfo createDefaultModelMBeanInfo() {
//
// return (new ModelMBeanInfoSupport(this.getClass().getName(),
//
// }
- /**
- * Is the specified <code>ModelMBeanInfo</code> instance valid?
- *
- * <p><strong>IMPLEMENTATION NOTE</strong> - This implementation
- * does not check anything, but this method can be overridden
- * as required.</p>
- *
- * @param info The <code>ModelMBeanInfo object to check
- */
+// /**
+// * Is the specified <code>ModelMBeanInfo</code> instance valid?
+// *
+
// * <p><strong>IMPLEMENTATION NOTE</strong> - This implementation
+// * does not check anything, but this method can be overridden
+// * as required.</p>
+// *
+// * @param info The <code>ModelMBeanInfo object to check
+// */
// protected boolean isModelMBeanInfoValid(ModelMBeanInfo info) {
// return (true);
// }
* take up a lot of CPU cycles.
* @param buf ByteBuffer - the buffer containing the data, we will read as until we have read at least one byte or we timed out
* @param socket SocketChannel - the socket to write data to
- * @param selector Selector - the selector to use for blocking, if null then a busy read will be initiated
* @param readTimeout long - the timeout for this read operation in milliseconds, -1 means no timeout
* @return int - returns the number of bytes read
* @throws EOFException if read returns -1
*/
public interface SSLSessionManager {
/**
- * Invalidate the specified SSL session
- * @param sessionId The ID of the session to invalidate.
+ * Invalidate the SSL session
*/
public void invalidateSession();
}
projects / tomcat7.0 / commitdiff