StartECLSessionMsg.java revision 5280
4501N/A * The contents of this file are subject to the terms of the 4501N/A * Common Development and Distribution License, Version 1.0 only 4501N/A * (the "License"). You may not use this file except in compliance 4501N/A * You can obtain a copy of the license at 4501N/A * See the License for the specific language governing permissions 4501N/A * and limitations under the License. 4501N/A * When distributing Covered Code, include this CDDL HEADER in each 4501N/A * file and include the License file at 4501N/A * add the following below this CDDL HEADER, with the fields enclosed 4501N/A * by brackets "[]" replaced with your own identifying information: 4501N/A * Portions Copyright [yyyy] [name of copyright owner] 5031N/A * Copyright 2009-2010 Sun Microsystems, Inc. 4501N/A * This class specifies the parameters of a search request on the ECL. 4501N/A * It is used as an interface between the requestor (plugin part) 4501N/A * This specifies that the ECL is requested from a provided cookie value 4501N/A * defined as a MultiDomainServerState. 4501N/A * This specifies that the ECL is requested from a provided interval 4501N/A * of change numbers (as defined by draft-good-ldap-changelog [CHANGELOG] 4501N/A * and NOT replication change numbers). 4501N/A * TODO: not yet implemented 4501N/A * This specifies that the ECL is requested ony for the entry that have 4501N/A * a repl change number matching the provided one. 4501N/A * TODO: not yet implemented 4501N/A * This specifies that the request on the ECL is a PERSISTENT search 4501N/A * with changesOnly = false. 4501N/A * This specifies that the request on the ECL is a NOT a PERSISTENT search. 4501N/A * This specifies that the request on the ECL is a PERSISTENT search 4501N/A // The type of request as defined by REQUEST_TYPE_... 4501N/A // When eclRequestType = FROM_COOKIE, 4501N/A // specifies the provided cookie value. 4501N/A // When eclRequestType = FROM_CHANGE_NUMBER, 4501N/A // specifies the provided change number first and last - [CHANGELOG] 4501N/A // When eclRequestType = EQUALS_REPL_CHANGE_NUMBER, 4501N/A // specifies the provided replication change number. 4501N/A // Specifies whether the search is persistent and changesOnly 4501N/A // A string helping debuging and tracing the client operation related when 4501N/A // processing, on the RS side, a request on the ECL. 4501N/A * Creates a new StartSessionMsg message from its encoded form. 4501N/A * @param in The byte array containing the encoded form of the message. 4501N/A * @throws java.util.zip.DataFormatException If the byte array does not 4501N/A * contain a valid encoded form of the message. 4501N/A * The message is stored in the form: 4501N/A * <message type><status><assured flag><assured mode><safe data level> 4501N/A * (each referral url terminates with 0) 4501N/A /* first bytes are the header */ 4501N/A /* first byte is the type */ 4501N/A // replication changeNumber 4501N/A * Creates a new StartSessionMsg message with the given required parameters. 4501N/A * Getter on the changer number start. 4501N/A * @return the changer number start. 4501N/A * Getter on the changer number stop. 4501N/A * @return the change number stop. 4501N/A * Setter on the first changer number (as defined by [CHANGELOG]). 4501N/A * @param firstDraftChangeNumber the provided first change number. 4501N/A * Setter on the last changer number (as defined by [CHANGELOG]). 4501N/A * @param lastDraftChangeNumber the provided last change number. 4501N/A * Getter on the replication change number. 4501N/A * @return the replication change number. 4501N/A * Setter on the replication change number. 4501N/A * @param changeNumber the provided replication change number. 4501N/A * Getter on the type of request. 4501N/A * @return the type of request. 4501N/A * Setter on the type of request. 4501N/A * @param eclRequestType the provided type of request. 4501N/A * Getter on the persistent property of the search request on the ECL. 4501N/A * @return the persistent property. 4501N/A * Setter on the persistent property of the search request on the ECL. 4501N/A * @param isPersistent the provided persistent property. 4501N/A * Getter of the cross domain server state. 4501N/A * @return the cross domain server state. 4501N/A * Setter of the cross domain server state. 4501N/A * @param crossDomainServerState the provided cross domain server state. 4501N/A * Setter of the operation id. 4501N/A * @param operationId The provided opration id. 4501N/A * Getter on the operation id. 4501N/A * @return the operation id. 4501N/A * Getter on the list of excluded ServiceIDs. 4501N/A * @return the list of excluded ServiceIDs. 4501N/A * Setter on the list of excluded ServiceIDs. 4501N/A * @param excludedServiceIDs the provided list of excluded ServiceIDs.