AutoRefactor: fix modifiers usage
1 files added
207 files modified
| New file |
| | |
| | | Feb 17, 2015 7:26:11 PM org.springframework.context.support.AbstractApplicationContext prepareRefresh |
| | | INFO: Refreshing org.springframework.context.annotation.AnnotationConfigApplicationContext@121a412b: startup date [Tue Feb 17 19:26:11 CET 2015]; root of context hierarchy |
| | | Feb 17, 2015 7:26:13 PM org.springframework.beans.factory.support.DefaultListableBeanFactory preInstantiateSingletons |
| | | INFO: Pre-instantiating singletons in org.springframework.beans.factory.support.DefaultListableBeanFactory@2128d41b: defining beans [org.springframework.context.annotation.internalConfigurationAnnotationProcessor,org.springframework.context.annotation.internalAutowiredAnnotationProcessor,org.springframework.context.annotation.internalRequiredAnnotationProcessor,org.springframework.context.annotation.internalCommonAnnotationProcessor,infinitestConfig,org.springframework.context.annotation.ConfigurationClassPostProcessor.importAwareProcessor,coreLifecycleObserver,swtEventQueue,visualStatusPresenter,slowTestObserver,resultCollectorBean,markerClearingRunnable,preferenceChangeHandler,infinitestActivationController,javaProjectSet,coreFactory,eclipseWorkspace,workspaceResourceFinder,infinitestCoreRegistry,markerPlacer,resourceLookupAdapter,slowMarkerRegistry,problemMarkerRegistry,markerClearingObserver,cleanEventProcessor,classFileChangeProcessor,coreUpdateNotifier,saveDetector,testResultAggregator,failureMediator,workspace,sourceContainer]; root of factory hierarchy |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2015 ForgeRock AS |
| | | */ |
| | | |
| | | package javax.jnlp; |
| | | |
| | | import java.io.IOException; |
| | | import java.net.URL; |
| | | |
| | | /** |
| | | * This is just an empty implementation of DownloadService. It does define |
| | | * only the methods of the JNLP API used in the class |
| | |
| | | * javaws.jar will be provided by the Java Web Start Runtime environment. So |
| | | * we are not providing the javaws-stub.jar during runtime: it is used only |
| | | * for compilation. |
| | | * |
| | | */ |
| | | public interface DownloadService { |
| | | public boolean isResourceCached(java.net.URL url, String version); |
| | | public void removeResource(java.net.URL url, String version) |
| | | throws java.io.IOException; |
| | | public void loadResource(java.net.URL ref, String version, |
| | | DownloadServiceListener listener) throws java.io.IOException; |
| | | boolean isResourceCached(URL url, String version); |
| | | void removeResource(URL url, String version) throws IOException; |
| | | void loadResource(URL ref, String version, DownloadServiceListener listener) throws IOException; |
| | | } |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2015 ForgeRock AS |
| | | */ |
| | | |
| | | package javax.jnlp; |
| | |
| | | * javaws.jar will be provided by the Java Web Start Runtime environment. So |
| | | * we are not providing the javaws-stub.jar during runtime: it is used only |
| | | * for compilation. |
| | | * |
| | | */ |
| | | import java.net.URL; |
| | | |
| | | public interface DownloadServiceListener { |
| | | public void downloadFailed(URL url, String version); |
| | | public void progress(URL url, String version, long readSoFar, long total, |
| | | int overallPercent); |
| | | public void upgradingArchive(URL url, String version, int patchPercent, |
| | | int overallPercent); |
| | | public void validating(URL url, String version, long entry, long total, |
| | | int overallPercent); |
| | | void downloadFailed(URL url, String version); |
| | | void progress(URL url, String version, long readSoFar, long total, int overallPercent); |
| | | void upgradingArchive(URL url, String version, int patchPercent, int overallPercent); |
| | | void validating(URL url, String version, long entry, long total, int overallPercent); |
| | | } |
| | |
| | | * |
| | | * |
| | | * Copyright 2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2015 ForgeRock AS |
| | | */ |
| | | package netscape.ldap; |
| | | |
| | |
| | | */ |
| | | public interface LDAPSocketFactory |
| | | { |
| | | public Socket makeSocket(String host, int port); |
| | | Socket makeSocket(String host, int port); |
| | | } |
| | | |
| | |
| | | /** |
| | | * The list of server properties that are multivalued. |
| | | */ |
| | | private final static Set<ServerProperty> MULTIVALUED_SERVER_PROPERTIES = |
| | | private static final Set<ServerProperty> MULTIVALUED_SERVER_PROPERTIES = |
| | | new HashSet<ServerProperty>(); |
| | | static |
| | | { |
| | |
| | | /** |
| | | * The list of server group properties that are multivalued. |
| | | */ |
| | | private final static |
| | | Set<ServerGroupProperty> MULTIVALUED_SERVER_GROUP_PROPERTIES = |
| | | private static final Set<ServerGroupProperty> MULTIVALUED_SERVER_GROUP_PROPERTIES = |
| | | new HashSet<ServerGroupProperty>(); |
| | | static |
| | | { |
| | |
| | | * |
| | | * |
| | | * Copyright 2008-2010 Sun Microsystems, Inc. |
| | | * Portions Copyright 2012-2014 ForgeRock AS |
| | | * Portions Copyright 2012-2015 ForgeRock AS |
| | | */ |
| | | |
| | | package org.opends.admin.ads.util; |
| | |
| | | * LDAP entry. |
| | | * @throws NamingException if there is an error processing the entry. |
| | | */ |
| | | static public String getFirstValue(SearchResult entry, String attrName) |
| | | public static String getFirstValue(SearchResult entry, String attrName) |
| | | throws NamingException |
| | | { |
| | | String v = null; |
| | |
| | | * in a LDAP entry. |
| | | * @throws NamingException if there is an error processing the entry. |
| | | */ |
| | | static public Set<String> getValues(SearchResult entry, String attrName) |
| | | public static Set<String> getValues(SearchResult entry, String attrName) |
| | | throws NamingException |
| | | { |
| | | Set<String> values = new HashSet<String>(); |
| | |
| | | */ |
| | | public class ControlPanelLauncher |
| | | { |
| | | static private ControlPanelArgumentParser argParser; |
| | | private static ControlPanelArgumentParser argParser; |
| | | |
| | | /** Prefix for log files. */ |
| | | static public final String LOG_FILE_PREFIX = "opendj-control-panel-"; |
| | | public static final String LOG_FILE_PREFIX = "opendj-control-panel-"; |
| | | |
| | | /** Suffix for log files. */ |
| | | static public final String LOG_FILE_SUFFIX = ".log"; |
| | | public static final String LOG_FILE_SUFFIX = ".log"; |
| | | |
| | | private static final LocalizedLogger logger = LocalizedLogger.getLoggerForThisClass(); |
| | | |
| | |
| | | * |
| | | * |
| | | * Copyright 2008-2009 Sun Microsystems, Inc. |
| | | * Portions Copyright 2014 ForgeRock AS |
| | | * Portions Copyright 2014-2015 ForgeRock AS |
| | | */ |
| | | package org.opends.guitools.controlpanel.datamodel; |
| | | |
| | |
| | | * localized name of the operation associated with the attribute). |
| | | * @return the message associated with the attribute. |
| | | */ |
| | | public LocalizableMessage getMessage(); |
| | | LocalizableMessage getMessage(); |
| | | |
| | | /** |
| | | * Returns the name of the attribute. |
| | | * @return the name of the attribute. |
| | | */ |
| | | public String getAttributeName(); |
| | | String getAttributeName(); |
| | | |
| | | /** |
| | | * Tells whether this is the number of aborted operations. |
| | | * @return <CODE>true</CODE> if this corresponds to the number of aborted |
| | | * operations and <CODE>false</CODE> otherwise. |
| | | */ |
| | | public boolean isAborted(); |
| | | boolean isAborted(); |
| | | |
| | | /** |
| | | * Return whether this attribute contains a numeric value or not. |
| | | * @return <CODE>true</CODE> if the value is numeric and <CODE>false</CODE> |
| | | * otherwise. |
| | | */ |
| | | public boolean isNumeric(); |
| | | boolean isNumeric(); |
| | | |
| | | /** |
| | | * Return whether this attribute contains a time value or not. |
| | | * @return <CODE>true</CODE> if the value is a time and <CODE>false</CODE> |
| | | * otherwise. |
| | | */ |
| | | public boolean isTime(); |
| | | boolean isTime(); |
| | | |
| | | /** |
| | | * Return whether this attribute contains a numeric date value or not. |
| | | * The date is a long value in miliseconds. |
| | | * The date is a long value in milliseconds. |
| | | * @return <CODE>true</CODE> if the value is date and <CODE>false</CODE> |
| | | * otherwise. |
| | | */ |
| | | public boolean isNumericDate(); |
| | | boolean isNumericDate(); |
| | | |
| | | /** |
| | | * Return whether this attribute contains a GMT date value or not. The date |
| | |
| | | * @return <CODE>true</CODE> if the value is a GMT date and <CODE>false</CODE> |
| | | * otherwise. |
| | | */ |
| | | public boolean isGMTDate(); |
| | | boolean isGMTDate(); |
| | | |
| | | /** |
| | | * Return whether this attribute represents a value in bytes or not. |
| | | * @return <CODE>true</CODE> if the value represents a value in bytes and |
| | | * <CODE>false</CODE> otherwise. |
| | | */ |
| | | public boolean isValueInBytes(); |
| | | boolean isValueInBytes(); |
| | | |
| | | /** |
| | | * Returns <CODE>true</CODE> if the average for this attribute makes sense |
| | |
| | | * @return <CODE>true</CODE> if the average for this attribute makes sense |
| | | * and <CODE>false</CODE> otherwise. |
| | | */ |
| | | public boolean canHaveAverage(); |
| | | boolean canHaveAverage(); |
| | | } |
| | |
| | | * @return <CODE>true</CODE> if the two schema attributes are equal and |
| | | * <CODE>false</CODE> otherwise. |
| | | */ |
| | | private static final boolean areAttributesEqual(AttributeType attr1, AttributeType attr2) |
| | | private static boolean areAttributesEqual(AttributeType attr1, AttributeType attr2) |
| | | { |
| | | return attr1.getOID().equals(attr2.getOID()) |
| | | && attr1.isCollective() == attr2.isCollective() |
| | |
| | | * @return <CODE>true</CODE> if the two schema objectclasses are equal and |
| | | * <CODE>false</CODE> otherwise. |
| | | */ |
| | | private static final boolean areObjectClassesEqual(ObjectClass oc1, ObjectClass oc2) |
| | | private static boolean areObjectClassesEqual(ObjectClass oc1, ObjectClass oc2) |
| | | { |
| | | return oc1.getOID().equals(oc2.getOID()) |
| | | && oc1.isExtensibleObject() == oc2.isExtensibleObject() |
| | |
| | | * |
| | | * |
| | | * Copyright 2009 Sun Microsystems, Inc. |
| | | * Portions Copyright 2015 ForgeRock AS |
| | | */ |
| | | |
| | | package org.opends.guitools.controlpanel.event; |
| | |
| | | * Method called when a set of backends are populated. |
| | | * @param ev the event notifying that a set of backends have been populated. |
| | | */ |
| | | public void backendPopulated(BackendPopulatedEvent ev); |
| | | void backendPopulated(BackendPopulatedEvent ev); |
| | | } |
| | |
| | | * |
| | | * |
| | | * Copyright 2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2015 ForgeRock AS |
| | | */ |
| | | |
| | | package org.opends.guitools.controlpanel.event; |
| | |
| | | * Method called when a backup is created. |
| | | * @param ev the event notifying that the backup was created. |
| | | */ |
| | | public void backupCreated(BackupCreatedEvent ev); |
| | | void backupCreated(BackupCreatedEvent ev); |
| | | } |
| | |
| | | * |
| | | * |
| | | * Copyright 2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2015 ForgeRock AS |
| | | */ |
| | | |
| | | package org.opends.guitools.controlpanel.event; |
| | |
| | | * generated. |
| | | * @param e the browser event. |
| | | */ |
| | | public void processBrowserEvent(BrowserEvent e); |
| | | void processBrowserEvent(BrowserEvent e); |
| | | } |
| | |
| | | * |
| | | * |
| | | * Copyright 2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2015 ForgeRock AS |
| | | */ |
| | | |
| | | package org.opends.guitools.controlpanel.event; |
| | |
| | | * Method that is called when a change in the configuration occurred. |
| | | * @param ev the configuration change event. |
| | | */ |
| | | public void configurationChanged(ConfigurationChangeEvent ev); |
| | | void configurationChanged(ConfigurationChangeEvent ev); |
| | | } |
| | |
| | | * |
| | | * |
| | | * Copyright 2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2015 ForgeRock AS |
| | | */ |
| | | |
| | | package org.opends.guitools.controlpanel.event; |
| | |
| | | * Method that is called when a new configuration element was created. |
| | | * @param ev the configuration change event. |
| | | */ |
| | | public void elementCreated(ConfigurationElementCreatedEvent ev); |
| | | void elementCreated(ConfigurationElementCreatedEvent ev); |
| | | } |
| | |
| | | * |
| | | * |
| | | * Copyright 2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2015 ForgeRock AS |
| | | */ |
| | | |
| | | package org.opends.guitools.controlpanel.event; |
| | |
| | | * Notifies that an entry was successfully read. |
| | | * @param ev the event containing the search result. |
| | | */ |
| | | public void entryRead(EntryReadEvent ev); |
| | | void entryRead(EntryReadEvent ev); |
| | | /** |
| | | * Notifies that an error reading an entry. |
| | | * @param ev the event describing the error. |
| | | */ |
| | | public void entryReadError(EntryReadErrorEvent ev); |
| | | void entryReadError(EntryReadErrorEvent ev); |
| | | } |
| | |
| | | * |
| | | * |
| | | * Copyright 2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2015 ForgeRock AS |
| | | */ |
| | | |
| | | package org.opends.guitools.controlpanel.event; |
| | | |
| | | /** |
| | | * Interface that must be implemented by the objects that want to receive |
| | | * notifications when an index has been modified. |
| | | * |
| | | */ |
| | | public interface IndexModifiedListener |
| | | { |
| | |
| | | * Notification that an index has been modified. |
| | | * @param ev the index event. |
| | | */ |
| | | public void indexModified(IndexModifiedEvent ev); |
| | | void indexModified(IndexModifiedEvent ev); |
| | | |
| | | /** |
| | | * Notification that the indexes in a backend have been modified. |
| | | * @param ev the index event. |
| | | */ |
| | | public void backendIndexesModified(IndexModifiedEvent ev); |
| | | void backendIndexesModified(IndexModifiedEvent ev); |
| | | } |
| | |
| | | * |
| | | * |
| | | * Copyright 2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2015 ForgeRock AS |
| | | */ |
| | | |
| | | package org.opends.guitools.controlpanel.event; |
| | | |
| | | /** |
| | | * Interface that must be implemented by the objects that want to receive |
| | | * notifications when an index has been selected. This is used in the dialog |
| | | * 'Manage Index' to notify that a new index is selected on the tree. |
| | | * |
| | | */ |
| | | public interface IndexSelectionListener |
| | | { |
| | |
| | | * Notification that an index has been selected. |
| | | * @param ev the index selection event. |
| | | */ |
| | | public void indexSelected(IndexSelectionEvent ev); |
| | | void indexSelected(IndexSelectionEvent ev); |
| | | } |
| | |
| | | * |
| | | * |
| | | * Copyright 2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2015 ForgeRock AS |
| | | */ |
| | | |
| | | package org.opends.guitools.controlpanel.event; |
| | |
| | | * Notification that an LDAP entry has been modified. |
| | | * @param ev the event. |
| | | */ |
| | | public void entryChanged(LDAPEntryChangedEvent ev); |
| | | void entryChanged(LDAPEntryChangedEvent ev); |
| | | } |
| | |
| | | * |
| | | * |
| | | * Copyright 2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2015 ForgeRock AS |
| | | */ |
| | | |
| | | package org.opends.guitools.controlpanel.event; |
| | |
| | | * Notification that the entry is being moved. |
| | | * @param ev the event. |
| | | */ |
| | | public void processMoveEvent(MoveEvent ev); |
| | | void processMoveEvent(MoveEvent ev); |
| | | } |
| | |
| | | * |
| | | * |
| | | * Copyright 2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2015 ForgeRock AS |
| | | */ |
| | | |
| | | package org.opends.guitools.controlpanel.event; |
| | |
| | | * Notification that a new line has been written in a PrintStream. |
| | | * @param line the new line. |
| | | */ |
| | | public void newLine(String line); |
| | | void newLine(String line); |
| | | } |
| | |
| | | * |
| | | * |
| | | * Copyright 2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2015 ForgeRock AS |
| | | */ |
| | | |
| | | package org.opends.guitools.controlpanel.event; |
| | |
| | | * Notification that some authentication changed. |
| | | * |
| | | */ |
| | | public void notifyAuthDataChanged(); |
| | | void notifyAuthDataChanged(); |
| | | } |
| | |
| | | * |
| | | * |
| | | * Copyright 2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2015 ForgeRock AS |
| | | */ |
| | | |
| | | package org.opends.guitools.controlpanel.event; |
| | |
| | | * Notification that a schema element has been selected. |
| | | * @param ev the schema element selection event. |
| | | */ |
| | | public void schemaElementSelected(SchemaElementSelectionEvent ev); |
| | | void schemaElementSelected(SchemaElementSelectionEvent ev); |
| | | } |
| | |
| | | */ |
| | | package org.opends.guitools.controlpanel.task; |
| | | |
| | | import static com.forgerock.opendj.cli.Utils.*; |
| | | import static com.forgerock.opendj.util.OperatingSystem.*; |
| | | |
| | | import static org.opends.messages.AdminToolMessages.*; |
| | | import static com.forgerock.opendj.util.OperatingSystem.isWindows; |
| | | import static com.forgerock.opendj.cli.Utils.OBFUSCATED_VALUE; |
| | | |
| | | import java.io.File; |
| | | import java.util.ArrayList; |
| | | import java.util.Collection; |
| | | import java.util.Map; |
| | | import java.util.List; |
| | | import java.util.Map; |
| | | import java.util.Set; |
| | | |
| | | import javax.naming.NamingException; |
| | |
| | | import javax.naming.directory.ModificationItem; |
| | | import javax.naming.ldap.InitialLdapContext; |
| | | |
| | | import org.forgerock.i18n.LocalizableMessage; |
| | | import org.forgerock.opendj.ldap.ByteString; |
| | | import org.opends.admin.ads.util.ConnectionUtils; |
| | | import org.opends.guitools.controlpanel.datamodel.ControlPanelInfo; |
| | | import org.opends.guitools.controlpanel.datamodel.ServerDescriptor; |
| | | import org.opends.guitools.controlpanel.event.ConfigurationElementCreatedEvent; |
| | | import org.opends.guitools.controlpanel.event. |
| | | ConfigurationElementCreatedListener; |
| | | import org.opends.guitools.controlpanel.event.ConfigurationElementCreatedListener; |
| | | import org.opends.guitools.controlpanel.event.PrintStreamListener; |
| | | import org.opends.guitools.controlpanel.ui.ColorAndFontConstants; |
| | | import org.opends.guitools.controlpanel.ui.ProgressDialog; |
| | |
| | | import org.opends.guitools.controlpanel.util.ConfigReader; |
| | | import org.opends.guitools.controlpanel.util.ProcessReader; |
| | | import org.opends.guitools.controlpanel.util.Utilities; |
| | | import org.forgerock.i18n.LocalizableMessage; |
| | | import org.opends.quicksetup.Installation; |
| | | import org.opends.quicksetup.UserData; |
| | | import org.forgerock.opendj.ldap.ByteString; |
| | | import org.opends.server.types.DN; |
| | | import org.opends.server.types.Schema; |
| | | import org.opends.server.util.Base64; |
| | | import org.opends.server.util.SetupUtils; |
| | | |
| | | import com.forgerock.opendj.cli.CommandBuilder; |
| | | |
| | | /** |
| | | * The class used to define a number of common methods and mechanisms for the |
| | | * tasks that are run in the Control Panel. |
| | | * |
| | | */ |
| | | public abstract class Task |
| | | { |
| | |
| | | private String binDir; |
| | | /** |
| | | * The different task types. |
| | | * |
| | | */ |
| | | public enum Type |
| | | { |
| | |
| | | * Add a new line to the logs. |
| | | * @param msg the new line. |
| | | */ |
| | | @Override |
| | | public void newLine(String msg) |
| | | { |
| | | outputLogs.append(msg).append("\n"); |
| | |
| | | * Add a new line to the error logs. |
| | | * @param msg the new line. |
| | | */ |
| | | @Override |
| | | public void newLine(String msg) |
| | | { |
| | | errorLogs.append(msg).append("\n"); |
| | |
| | | /** |
| | | * The separator used to link the lines of the resulting command-lines. |
| | | */ |
| | | private final static String LINE_SEPARATOR = |
| | | CommandBuilder.HTML_LINE_SEPARATOR; |
| | | private static final String LINE_SEPARATOR = CommandBuilder.HTML_LINE_SEPARATOR; |
| | | |
| | | /** |
| | | * Returns the equivalent command line in HTML without font properties. |
| | |
| | | List<String> args) |
| | | { |
| | | StringBuilder sb = new StringBuilder(cmdName); |
| | | for (int i=0; i<args.size(); i++) |
| | | for (String arg : args) |
| | | { |
| | | String arg = args.get(i); |
| | | if (arg.charAt(0) == '-') |
| | | { |
| | | sb.append(LINE_SEPARATOR); |
| | |
| | | * |
| | | * |
| | | * Copyright 2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2014 ForgeRock AS |
| | | * Portions Copyright 2014-2015 ForgeRock AS |
| | | */ |
| | | |
| | | package org.opends.guitools.controlpanel.ui; |
| | |
| | | |
| | | private boolean valueChanged; |
| | | |
| | | private final static int MAX_IMAGE_HEIGHT = 300; |
| | | private final static int MAX_BASE64_TO_DISPLAY = 3 * 1024; |
| | | private static final int MAX_IMAGE_HEIGHT = 300; |
| | | private static final int MAX_BASE64_TO_DISPLAY = 3 * 1024; |
| | | |
| | | private static final LocalizedLogger logger = LocalizedLogger.getLoggerForThisClass(); |
| | | |
| | |
| | | * |
| | | * |
| | | * Copyright 2008-2010 Sun Microsystems, Inc. |
| | | * Portions Copyright 2014 ForgeRock AS |
| | | * Portions Copyright 2014-2015 ForgeRock AS |
| | | */ |
| | | |
| | | package org.opends.guitools.controlpanel.ui; |
| | |
| | | /** |
| | | * The font of the table header. |
| | | */ |
| | | public final static Font headerFont = |
| | | public static final Font headerFont = |
| | | UIManager.getFont("TableHeader.font").deriveFont(Font.BOLD); |
| | | /** |
| | | * The font to be used in the title of the error panes. |
| | |
| | | /** |
| | | * The font to be used in the table. |
| | | */ |
| | | public final static Font tableFont = UIManager.getFont("Table.font"); |
| | | public static final Font tableFont = UIManager.getFont("Table.font"); |
| | | /** |
| | | * The font to be used in the title of the TitlePanel component. |
| | | */ |
| | | public final static Font titleFont = |
| | | public static final Font titleFont = |
| | | defaultFont.deriveFont(Font.BOLD).deriveFont(14f); |
| | | /** |
| | | * Text color indicating that a field is not valid. |
| | |
| | | * |
| | | * |
| | | * Copyright 2008-2009 Sun Microsystems, Inc. |
| | | * Portions Copyright 2014 ForgeRock AS |
| | | * Portions Copyright 2014-2015 ForgeRock AS |
| | | */ |
| | | package org.opends.guitools.controlpanel.ui; |
| | | |
| | |
| | | public class GenericDialog extends JDialog |
| | | { |
| | | private static final long serialVersionUID = -2643144936460484112L; |
| | | private final static Color buttonPanelBackground = |
| | | private static final Color buttonPanelBackground = |
| | | ColorAndFontConstants.greyBackground; |
| | | private JButton okButton; |
| | | |
| | |
| | | * |
| | | * |
| | | * Copyright 2009 Sun Microsystems, Inc. |
| | | * Portions Copyright 2014 ForgeRock AS |
| | | * Portions Copyright 2014-2015 ForgeRock AS |
| | | */ |
| | | package org.opends.guitools.controlpanel.ui; |
| | | |
| | |
| | | public class GenericFrame extends JFrame |
| | | { |
| | | private static final long serialVersionUID = -2643144936460484112L; |
| | | private final static Color buttonPanelBackground = |
| | | private static final Color buttonPanelBackground = |
| | | ColorAndFontConstants.greyBackground; |
| | | private JButton okButton; |
| | | |
| | |
| | | * |
| | | * |
| | | * Copyright 2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2014 ForgeRock AS |
| | | * Portions Copyright 2014-2015 ForgeRock AS |
| | | */ |
| | | |
| | | package org.opends.guitools.controlpanel.ui; |
| | |
| | | private BackendVLVIndexesPanel backendVLVIndexesPanel = |
| | | new BackendVLVIndexesPanel(); |
| | | |
| | | private final static String NOTHING_SELECTED = "Nothing Selected"; |
| | | private final static String MULTIPLE_SELECTED = "Multiple Selected"; |
| | | private static final String NOTHING_SELECTED = "Nothing Selected"; |
| | | private static final String MULTIPLE_SELECTED = "Multiple Selected"; |
| | | |
| | | /** |
| | | * Default constructor. |
| | |
| | | * |
| | | * |
| | | * Copyright 2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2014 ForgeRock AS |
| | | * Portions Copyright 2014-2015 ForgeRock AS |
| | | */ |
| | | |
| | | package org.opends.guitools.controlpanel.ui.components; |
| | |
| | | |
| | | private Object value; |
| | | |
| | | private final static int THUMBNAIL_HEIGHT = 50; |
| | | private static final int THUMBNAIL_HEIGHT = 50; |
| | | |
| | | private static final LocalizedLogger logger = LocalizedLogger.getLoggerForThisClass(); |
| | | |
| | |
| | | * |
| | | * |
| | | * Copyright 2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2015 ForgeRock AS |
| | | */ |
| | | |
| | | package org.opends.guitools.controlpanel.ui.components; |
| | |
| | | private static final long serialVersionUID = 6191857253411571940L; |
| | | private Border buttonSelectedBorder; |
| | | private Border buttonUnselectedBorder; |
| | | private final static Color backgroundColor = |
| | | private static final Color backgroundColor = |
| | | ColorAndFontConstants.greyBackground; |
| | | |
| | | /** |
| | |
| | | * |
| | | * |
| | | * Copyright 2008-2010 Sun Microsystems, Inc. |
| | | * Portions Copyright 2015 ForgeRock AS |
| | | */ |
| | | |
| | | package org.opends.guitools.controlpanel.ui.nodes; |
| | |
| | | * URL of the displayed entry. |
| | | * @return the URL of the displayed entry. |
| | | */ |
| | | public LDAPURL getURL(); |
| | | LDAPURL getURL(); |
| | | |
| | | |
| | | /** |
| | |
| | | * @return <CODE>true</CODE> if the displayed entry is the top entry of a |
| | | * suffix and <CODE>false</CODE> otherwise. |
| | | */ |
| | | public boolean isSuffix(); |
| | | boolean isSuffix(); |
| | | |
| | | |
| | | /** |
| | |
| | | * @return <CODE>true</CODE> if the displayed entry is the root node of the |
| | | * server (the dn="" entry) and <CODE>false</CODE> otherwise. |
| | | */ |
| | | public boolean isRootNode(); |
| | | boolean isRootNode(); |
| | | |
| | | /** |
| | | * Returns <CODE>true</CODE> if the displayed entry is not located on the |
| | |
| | | * the browser controller. Returns <CODE>false</CODE> otherwise. |
| | | * |
| | | */ |
| | | public boolean isRemote(); |
| | | boolean isRemote(); |
| | | |
| | | |
| | | /** |
| | |
| | | * -1 if the numsubordinates attribute is not defined. |
| | | * @return the value of numsubordinates for the entry. |
| | | */ |
| | | public int getNumSubOrdinates(); |
| | | int getNumSubOrdinates(); |
| | | |
| | | |
| | | /** |
| | | * Returns the value of hassubordinates for the entry. |
| | | * @return the value of hassubordinates for the entry. |
| | | */ |
| | | public boolean hasSubOrdinates(); |
| | | boolean hasSubOrdinates(); |
| | | |
| | | /** |
| | | * Returns the referrals attached to the displayed entry. |
| | |
| | | * Returns <CODE>null</CODE> if the attribute is not present. |
| | | * @return the referrals attached to the displayed entry. |
| | | */ |
| | | public String[] getReferral(); |
| | | String[] getReferral(); |
| | | |
| | | |
| | | /** |
| | | * Returns the error detected while reading this entry. |
| | | * @return the error detected while reading this entry. |
| | | */ |
| | | public int getErrorType(); |
| | | int getErrorType(); |
| | | |
| | | |
| | | /** |
| | |
| | | * Returns <CODE>null</CODE> if getErrorType() == ERROR_NONE. |
| | | * @return the exception associated to the error. |
| | | */ |
| | | public Exception getErrorException(); |
| | | Exception getErrorException(); |
| | | |
| | | |
| | | /** |
| | |
| | | * errorArg contains the String representing the faulty LDAP URL. |
| | | * @return the argument associated to an error/exception. |
| | | */ |
| | | public Object getErrorArg(); |
| | | Object getErrorArg(); |
| | | |
| | | /** |
| | | * Returns the basic node associated with the node info. |
| | | * @return the basic node associated with the node info. |
| | | */ |
| | | public BasicNode getNode(); |
| | | BasicNode getNode(); |
| | | |
| | | |
| | | /** |
| | | * Returns the TreePath corresponding to the displayed entry. |
| | | * @return the TreePath corresponding to the displayed entry. |
| | | */ |
| | | public TreePath getTreePath(); |
| | | TreePath getTreePath(); |
| | | |
| | | |
| | | /** |
| | | * Tells wether the node passed as parameter represents the same node as this |
| | | * Tells whether the node passed as parameter represents the same node as this |
| | | * one. |
| | | * @param node the node. |
| | | * @return <CODE>true</CODE> if the node passed as parameter represents the |
| | | * same node as this one and <CODE>false</CODE> otherwise. |
| | | */ |
| | | public boolean representsSameNode(BrowserNodeInfo node); |
| | | boolean representsSameNode(BrowserNodeInfo node); |
| | | |
| | | /** |
| | | * Returns the object class value of the entry that the nodes represents. |
| | | * @return the object class value of the entry that the nodes represents. |
| | | */ |
| | | public String[] getObjectClassValues(); |
| | | String[] getObjectClassValues(); |
| | | |
| | | /** |
| | | * Error types |
| | |
| | | /** |
| | | * No error happened. |
| | | */ |
| | | public static final int ERROR_NONE = 0; |
| | | int ERROR_NONE = 0; |
| | | /** |
| | | * And error reading the entry occurred. |
| | | */ |
| | | public static final int ERROR_READING_ENTRY = 1; |
| | | int ERROR_READING_ENTRY = 1; |
| | | /** |
| | | * An error following referrals occurred. |
| | | */ |
| | | public static final int ERROR_SOLVING_REFERRAL = 2; |
| | | int ERROR_SOLVING_REFERRAL = 2; |
| | | /** |
| | | * An error occurred searching the children of the entry. |
| | | */ |
| | | public static final int ERROR_SEARCHING_CHILDREN = 3; |
| | | |
| | | |
| | | int ERROR_SEARCHING_CHILDREN = 3; |
| | | |
| | | } |
| | |
| | | * |
| | | * |
| | | * Copyright 2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2015 ForgeRock AS |
| | | */ |
| | | |
| | | package org.opends.guitools.controlpanel.ui.nodes; |
| | |
| | | /** |
| | | * The data flavor managed by this transferable. |
| | | */ |
| | | final public static DataFlavor INFO_FLAVOR = |
| | | public static final DataFlavor INFO_FLAVOR = |
| | | new DataFlavor(BrowserNodeInfo.class, "Browse Node Information"); |
| | | |
| | | static DataFlavor[] FLAVORS = {INFO_FLAVOR }; |
| | |
| | | * |
| | | * |
| | | * Copyright 2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2015 ForgeRock AS |
| | | */ |
| | | |
| | | package org.opends.guitools.controlpanel.ui.renderer; |
| | |
| | | private static final long serialVersionUID = -4645902129785751854L; |
| | | private DateFormat formatter = DateFormat.getDateInstance(DateFormat.FULL); |
| | | private File backupParentPath; |
| | | private final static Border fullBorder = BorderFactory.createCompoundBorder( |
| | | private static final Border fullBorder = BorderFactory.createCompoundBorder( |
| | | BorderFactory.createMatteBorder(1, 0, 0, 0, |
| | | ColorAndFontConstants.gridColor), |
| | | BorderFactory.createEmptyBorder(4, 4, 4, 4)); |
| | | private final static Border incrementalBorder = |
| | | private static final Border incrementalBorder = |
| | | BorderFactory.createEmptyBorder(4, 4, 4, 4); |
| | | |
| | | /** |
| | |
| | | * |
| | | * |
| | | * Copyright 2008-2009 Sun Microsystems, Inc. |
| | | * Portions Copyright 2014 ForgeRock AS |
| | | * Portions Copyright 2014-2015 ForgeRock AS |
| | | */ |
| | | |
| | | package org.opends.guitools.controlpanel.ui.renderer; |
| | |
| | | /** |
| | | * The border of the first column. |
| | | */ |
| | | protected final static Border column0Border = |
| | | protected static final Border column0Border = |
| | | BorderFactory.createCompoundBorder( |
| | | BorderFactory.createMatteBorder(0, 1, 0, 0, |
| | | ColorAndFontConstants.gridColor), |
| | |
| | | /** |
| | | * The default border. |
| | | */ |
| | | public final static Border defaultBorder = |
| | | public static final Border defaultBorder = |
| | | BorderFactory.createEmptyBorder(4, 4, 4, 4); |
| | | private static Border defaultFocusBorder; |
| | | |
| | |
| | | * |
| | | * |
| | | * Copyright 2009 Sun Microsystems, Inc. |
| | | * Portions Copyright 2015 ForgeRock AS |
| | | */ |
| | | |
| | | package org.opends.guitools.controlpanel.ui.renderer; |
| | |
| | | * The border of the first column. |
| | | * TODO: modify CustomCellRenderer to make this public. |
| | | */ |
| | | protected final static Border column0Border = |
| | | protected static final Border column0Border = |
| | | BorderFactory.createCompoundBorder( |
| | | BorderFactory.createMatteBorder(0, 1, 0, 0, |
| | | ColorAndFontConstants.gridColor), |
| | |
| | | /** |
| | | * The default border. |
| | | */ |
| | | public final static Border defaultBorder = CustomCellRenderer.defaultBorder; |
| | | public static final Border defaultBorder = CustomCellRenderer.defaultBorder; |
| | | |
| | | /** |
| | | * Default constructor. |
| | |
| | | private static String[] packages = { |
| | | "org.opends" |
| | | }; |
| | | static private File logFile; |
| | | static private FileHandler fileHandler; |
| | | private static File logFile; |
| | | private static FileHandler fileHandler; |
| | | |
| | | /** |
| | | * Creates a new file handler for writing log messages to the file indicated |
| | |
| | | * @param file log file to which log messages will be written |
| | | * @throws IOException if something goes wrong |
| | | */ |
| | | static public void initLogFileHandler(File file) throws IOException { |
| | | public static void initLogFileHandler(File file) throws IOException { |
| | | if (!isInitialized()) |
| | | { |
| | | logFile = file; |
| | |
| | | * @param packageName the package name. |
| | | * @throws IOException if something goes wrong |
| | | */ |
| | | static public void initPackage(String packageName) throws IOException { |
| | | public static void initPackage(String packageName) throws IOException { |
| | | Logger logger = Logger.getLogger(packageName); |
| | | if (disableLoggingToConsole()) |
| | | { |
| | |
| | | * Gets the name of the log file. |
| | | * @return File representing the log file |
| | | */ |
| | | static public File getLogFile() { |
| | | public static File getLogFile() { |
| | | return logFile; |
| | | } |
| | | |
| | |
| | | * Indicates whether or not the log file has been initialized. |
| | | * @return true when the log file has been initialized |
| | | */ |
| | | static public boolean isInitialized() { |
| | | public static boolean isInitialized() { |
| | | return logFile != null; |
| | | } |
| | | |
| | | static private String getInitialLogRecord() { |
| | | private static String getInitialLogRecord() { |
| | | StringBuilder sb = new StringBuilder() |
| | | .append("Application launched " + |
| | | DateFormat.getDateTimeInstance(DateFormat.LONG, |
| | |
| | | public class UninstallLauncher extends Launcher { |
| | | |
| | | /** Prefix for log files. */ |
| | | static public final String LOG_FILE_PREFIX = "opendj-uninstall-"; |
| | | public static final String LOG_FILE_PREFIX = "opendj-uninstall-"; |
| | | |
| | | /** Suffix for log files. */ |
| | | static public final String LOG_FILE_SUFFIX = ".log"; |
| | | public static final String LOG_FILE_SUFFIX = ".log"; |
| | | |
| | | /** |
| | | * The main method which is called by the uninstall command lines. |
| | |
| | | * @throws ApplicationException if all or some important information could |
| | | * not be determined |
| | | */ |
| | | static public BuildInformation create(Installation installation) |
| | | public static BuildInformation create(Installation installation) |
| | | throws ApplicationException { |
| | | BuildInformation bi = new BuildInformation(); |
| | | List<String> args = new ArrayList<String>(); |
| | |
| | | * @throws IllegalArgumentException if <code>bn</code> is not a build |
| | | * number |
| | | */ |
| | | static public BuildInformation fromBuildString(String bn) throws |
| | | public static BuildInformation fromBuildString(String bn) throws |
| | | IllegalArgumentException |
| | | { |
| | | // ------------------------------------------------------- |
| | |
| | | return hc; |
| | | } |
| | | |
| | | static private void checkNotNull(Map<?, ?> values, String... props) |
| | | private static void checkNotNull(Map<?, ?> values, String... props) |
| | | throws ApplicationException { |
| | | for (String prop : props) { |
| | | if (null == values.get(prop)) { |
| | |
| | | * |
| | | * |
| | | * Copyright 2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2011-2014 ForgeRock AS |
| | | * Portions Copyright 2011-2015 ForgeRock AS |
| | | */ |
| | | package org.opends.quicksetup; |
| | | |
| | |
| | | public class Constants { |
| | | |
| | | /** Platform appropriate line separator. */ |
| | | static public final String LINE_SEPARATOR = |
| | | public static final String LINE_SEPARATOR = |
| | | System.getProperty("line.separator"); |
| | | |
| | | /** HTML line break tag. */ |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2010 Sun Microsystems, Inc. |
| | | * Portions Copyright 2011-2014 ForgeRock AS |
| | | * Portions Copyright 2011-2015 ForgeRock AS |
| | | */ |
| | | package org.opends.quicksetup; |
| | | |
| | |
| | | * indicating the reason why <code>rootDirectory</code> is not a |
| | | * valid OpenDJ install root. |
| | | */ |
| | | static public void validateRootDirectory(File rootDirectory) |
| | | public static void validateRootDirectory(File rootDirectory) |
| | | throws IllegalArgumentException |
| | | { |
| | | LocalizableMessage failureReason = null; |
| | |
| | | |
| | | |
| | | |
| | | static private Installation local; |
| | | private static Installation local; |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return Installation obtained by reading the classpath |
| | | */ |
| | | static public Installation getLocal() |
| | | public static Installation getLocal() |
| | | { |
| | | if (local == null) |
| | | { |
| | |
| | | * in some operating systems. |
| | | * @return internationalized String representing the frame title |
| | | */ |
| | | abstract protected LocalizableMessage getFrameTitle(); |
| | | protected abstract LocalizableMessage getFrameTitle(); |
| | | |
| | | /** |
| | | * Launches the command line based uninstall. |
| | |
| | | /** |
| | | * The license file name in Legal directory. |
| | | */ |
| | | private final static String LICENSE_FILE_NAME = "license_to_accept.txt"; |
| | | private static final String LICENSE_FILE_NAME = "license_to_accept.txt"; |
| | | |
| | | /** |
| | | * The Legal folder which contains license file. |
| | | */ |
| | | private final static String LEGAL_FOLDER_NAME = "Legal"; |
| | | private static final String LEGAL_FOLDER_NAME = "Legal"; |
| | | |
| | | /** |
| | | * The accepted license file name. |
| | | */ |
| | | private final static String ACCEPTED_LICENSE_FILE_NAME = "licenseAccepted"; |
| | | private static final String ACCEPTED_LICENSE_FILE_NAME = "licenseAccepted"; |
| | | |
| | | /** |
| | | * Get the directory in which legal files are stored. |
| | |
| | | /** |
| | | * The File object related to the license file. |
| | | */ |
| | | static private File licFile; |
| | | private static File licFile; |
| | | |
| | | /** |
| | | * The license file approval state. |
| | | */ |
| | | static private boolean approved; |
| | | private static boolean approved; |
| | | |
| | | /** |
| | | * Returns the license file name. |
| | | */ |
| | | static private String getName() |
| | | private static String getName() |
| | | { |
| | | return getInstanceLegalDirectory() + File.separatorChar |
| | | + LICENSE_FILE_NAME; |
| | |
| | | /** |
| | | * Returns the license file object. |
| | | */ |
| | | static private File getFile() |
| | | private static File getFile() |
| | | { |
| | | if (licFile == null) |
| | | { |
| | | licFile = new File(getName()); |
| | | } |
| | | |
| | | return licFile; |
| | | } |
| | | |
| | | /** |
| | | * Returns the URL to the license file when using jnlp / java web start. |
| | | */ |
| | | static private URL getWebStartLicenseFile() |
| | | private static URL getWebStartLicenseFile() |
| | | { |
| | | final String licenseResource = |
| | | LEGAL_FOLDER_NAME + File.separatorChar + LICENSE_FILE_NAME; |
| | |
| | | * in the top level installation directory <CODE>false</CODE> |
| | | * otherwise. |
| | | */ |
| | | static public boolean exists() |
| | | public static boolean exists() |
| | | { |
| | | if (Utils.isWebStart()) |
| | | { |
| | | return (getWebStartLicenseFile() != null); |
| | | return getWebStartLicenseFile() != null; |
| | | } |
| | | else |
| | | { |
| | |
| | | * |
| | | * @return the textual contents of the license file. |
| | | */ |
| | | static public String getText() |
| | | public static String getText() |
| | | { |
| | | InputStream input = null; |
| | | // Gets the inputstream of the license |
| | |
| | | * @return <CODE>true</CODE> if the license has been accepted by the user |
| | | * <CODE>false</CODE> otherwise. |
| | | */ |
| | | static public boolean getApproval() |
| | | public static boolean getApproval() |
| | | { |
| | | return approved; |
| | | } |
| | |
| | | * @param p_approved |
| | | * the license approval status |
| | | */ |
| | | static public void setApproval(boolean p_approved) |
| | | public static void setApproval(boolean p_approved) |
| | | { |
| | | approved = p_approved; |
| | | } |
| | |
| | | * @param installationPath |
| | | * The server installation's path. |
| | | */ |
| | | static public void createFileLicenseApproved(final String installationPath) |
| | | public static void createFileLicenseApproved(final String installationPath) |
| | | { |
| | | if (getApproval() && installationPath != null) |
| | | { |
| | |
| | | * @return <CODE>true</CODE> if the license had already been approved by the |
| | | * user <CODE>false</CODE> otherwise. |
| | | */ |
| | | static public boolean isAlreadyApproved() |
| | | public static boolean isAlreadyApproved() |
| | | { |
| | | final File f = |
| | | new File(getInstanceLegalDirectory() + File.separatorChar |
| | |
| | | */ |
| | | public class QuickSetupLog { |
| | | |
| | | static private File logFile; |
| | | static private FileHandler fileHandler; |
| | | private static File logFile; |
| | | private static FileHandler fileHandler; |
| | | |
| | | /** |
| | | * Creates a new file handler for writing log messages to the file indicated |
| | |
| | | * @param file log file to which log messages will be written |
| | | * @throws IOException if something goes wrong |
| | | */ |
| | | static public void initLogFileHandler(File file) throws IOException { |
| | | public static void initLogFileHandler(File file) throws IOException { |
| | | if (!isInitialized()) { |
| | | logFile = file; |
| | | fileHandler = new FileHandler(logFile.getCanonicalPath()); |
| | |
| | | * log messages. |
| | | * @throws IOException if something goes wrong |
| | | */ |
| | | static public void initLogFileHandler(File file, String packageName) |
| | | public static void initLogFileHandler(File file, String packageName) |
| | | throws IOException { |
| | | initLogFileHandler(file); |
| | | Logger logger = Logger.getLogger(packageName); |
| | |
| | | * Prevents messages written to loggers from appearing in the console |
| | | * output. |
| | | */ |
| | | static public void disableConsoleLogging() { |
| | | public static void disableConsoleLogging() { |
| | | if (disableLoggingToConsole()) |
| | | { |
| | | Logger logger = Logger.getLogger("org.opends"); |
| | |
| | | * Gets the name of the log file. |
| | | * @return File representing the log file |
| | | */ |
| | | static public File getLogFile() { |
| | | public static File getLogFile() { |
| | | return logFile; |
| | | } |
| | | |
| | |
| | | * Indicates whether or not the log file has been initialized. |
| | | * @return true when the log file has been initialized |
| | | */ |
| | | static public boolean isInitialized() { |
| | | public static boolean isInitialized() { |
| | | return logFile != null; |
| | | } |
| | | |
| | | static private String getInitialLogRecord() { |
| | | private static String getInitialLogRecord() { |
| | | // Note; currently the logs are not internationalized. |
| | | return "QuickSetup application launched " + |
| | | DateFormat.getDateTimeInstance(DateFormat.LONG, |
| | |
| | | * |
| | | * |
| | | * Copyright 2008-2010 Sun Microsystems, Inc. |
| | | * Portions copyright 2011-2014 ForgeRock AS. |
| | | * Portions Copyright 2011-2015 ForgeRock AS. |
| | | */ |
| | | package org.opends.quicksetup; |
| | | |
| | |
| | | * @return the free port of type x389 if it is available and we can use and -1 |
| | | * if not. |
| | | */ |
| | | static public int getDefaultPort() |
| | | public static int getDefaultPort() |
| | | { |
| | | return getDefaultPort(389); |
| | | } |
| | |
| | | * @return the free port of type x444 if it is available and we can use and -1 |
| | | * if not. |
| | | */ |
| | | static public int getDefaultAdminConnectorPort() |
| | | public static int getDefaultAdminConnectorPort() |
| | | { |
| | | return getDefaultPort(4444); |
| | | } |
| | |
| | | * @param forbiddenPorts an array of ports that we cannot use. |
| | | * @return the port X689 if it is available and we can use and -1 if not. |
| | | */ |
| | | static public int getDefaultJMXPort(int[] forbiddenPorts) |
| | | public static int getDefaultJMXPort(int[] forbiddenPorts) |
| | | { |
| | | int defaultJMXPort = -1; |
| | | |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2015 ForgeRock AS |
| | | */ |
| | | |
| | | package org.opends.quicksetup.event; |
| | |
| | | /** |
| | | * Interface used for the actions that are done in the wizard buttons (those |
| | | * specified in org.opends.quicksetup.ButtonName). |
| | | * |
| | | */ |
| | | public interface ButtonActionListener |
| | | { |
| | | /** |
| | | * Method called when the user clicks on one of the buttons specifid in |
| | | * Method called when the user clicks on one of the buttons specified in |
| | | * org.opends.quicksetup.ButtonName. |
| | | * @param event the button event |
| | | */ |
| | | public void buttonActionPerformed(ButtonEvent event); |
| | | void buttonActionPerformed(ButtonEvent event); |
| | | } |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2015 ForgeRock AS |
| | | */ |
| | | |
| | | package org.opends.quicksetup.event; |
| | |
| | | * @param ev the ProgressUpdateEvent describing the update that |
| | | * occurred in the installation progress. |
| | | */ |
| | | public void progressUpdate(ProgressUpdateEvent ev); |
| | | void progressUpdate(ProgressUpdateEvent ev); |
| | | |
| | | } |
| | |
| | | * |
| | | * |
| | | * Copyright 2010 Sun Microsystems, Inc. |
| | | * Portions Copyright 2011-2014 ForgeRock AS |
| | | * Portions Copyright 2011-2015 ForgeRock AS |
| | | */ |
| | | |
| | | package org.opends.quicksetup.installer.ui; |
| | |
| | | } |
| | | } |
| | | |
| | | private final static String INSTALL_PATH = |
| | | private static final String INSTALL_PATH = |
| | | Utils.getInstallPathFromClasspath(); |
| | | |
| | | private void checkOptions(String options, Collection<LocalizableMessage> errorMsgs, |
| | |
| | | * |
| | | * |
| | | * Copyright 2008-2010 Sun Microsystems, Inc. |
| | | * Portions Copyright 2012-2014 ForgeRock AS. |
| | | * Portions Copyright 2012-2015 ForgeRock AS. |
| | | */ |
| | | |
| | | package org.opends.quicksetup.ui; |
| | |
| | | * in some operating systems. |
| | | * @return internationalized String representing the frame title |
| | | */ |
| | | abstract public LocalizableMessage getFrameTitle(); |
| | | public abstract LocalizableMessage getFrameTitle(); |
| | | |
| | | /** |
| | | * Returns the initial wizard step. |
| | |
| | | * @param dlg QuickSetupDialog that will be closing |
| | | * @param evt The event from the Window indicating closing |
| | | */ |
| | | abstract public void windowClosing(QuickSetupDialog dlg, WindowEvent evt); |
| | | public abstract void windowClosing(QuickSetupDialog dlg, WindowEvent evt); |
| | | |
| | | /** |
| | | * This method is called when we detected that there is something installed |
| | |
| | | * Get the name of the button that will receive initial focus. |
| | | * @return ButtonName of the button to receive initial focus |
| | | */ |
| | | abstract public ButtonName getInitialFocusButtonName(); |
| | | public abstract ButtonName getInitialFocusButtonName(); |
| | | |
| | | /** |
| | | * Creates the main panel for the wizard dialog. |
| | |
| | | * Returns the set of wizard steps used in this application's wizard. |
| | | * @return Set of Step objects representing wizard steps |
| | | */ |
| | | abstract public Set<? extends WizardStep> getWizardSteps(); |
| | | public abstract Set<? extends WizardStep> getWizardSteps(); |
| | | |
| | | /** |
| | | * Creates a wizard panel given a specific step. |
| | | * @param step for which a panel representation should be created |
| | | * @return QuickSetupStepPanel for representing the <code>step</code> |
| | | */ |
| | | abstract public QuickSetupStepPanel createWizardStepPanel(WizardStep step); |
| | | public abstract QuickSetupStepPanel createWizardStepPanel(WizardStep step); |
| | | |
| | | /** |
| | | * Gets the next step in the wizard given a current step. |
| | | * @param step Step the current step |
| | | * @return Step the next step |
| | | */ |
| | | abstract public WizardStep getNextWizardStep(WizardStep step); |
| | | public abstract WizardStep getNextWizardStep(WizardStep step); |
| | | |
| | | /** |
| | | * Gets the previous step in the wizard given a current step. |
| | | * @param step Step the current step |
| | | * @return Step the previous step |
| | | */ |
| | | abstract public WizardStep getPreviousWizardStep(WizardStep step); |
| | | public abstract WizardStep getPreviousWizardStep(WizardStep step); |
| | | |
| | | /** |
| | | * Gets the finished step in the wizard. |
| | | * @return Step the finished step |
| | | */ |
| | | abstract public WizardStep getFinishedStep(); |
| | | public abstract WizardStep getFinishedStep(); |
| | | |
| | | /** |
| | | * Gets the currently displayed wizard step. |
| | |
| | | * |
| | | * |
| | | * Copyright 2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2015 ForgeRock AS |
| | | */ |
| | | |
| | | package org.opends.quicksetup.ui; |
| | |
| | | * @return <CODE>true</CODE> if the sort is ascending and <CODE>false</CODE> |
| | | * otherwise. |
| | | */ |
| | | public boolean isSortAscending(); |
| | | boolean isSortAscending(); |
| | | |
| | | /** |
| | | * Sets whether to sort ascending of descending. |
| | | * @param sortAscending whether to sort ascending or descending. |
| | | */ |
| | | public void setSortAscending(boolean sortAscending); |
| | | void setSortAscending(boolean sortAscending); |
| | | |
| | | /** |
| | | * Returns the column index used to sort. |
| | | * @return the column index used to sort. |
| | | */ |
| | | public int getSortColumn(); |
| | | int getSortColumn(); |
| | | |
| | | /** |
| | | * Sets the column index used to sort. |
| | | * @param sortColumn column index used to sort.. |
| | | */ |
| | | public void setSortColumn(int sortColumn); |
| | | void setSortColumn(int sortColumn); |
| | | |
| | | /** |
| | | * Updates the table model contents and sorts its contents depending on the |
| | | * sort options set by the user. |
| | | */ |
| | | public void forceResort(); |
| | | void forceResort(); |
| | | } |
| | |
| | | * @param desc the LabelFieldDescriptor describing the JLabel. |
| | | * @return a JLabel based on a LabelFieldDescriptor. |
| | | */ |
| | | static public JLabel makeJLabel(LabelFieldDescriptor desc) |
| | | public static JLabel makeJLabel(LabelFieldDescriptor desc) |
| | | { |
| | | UIFactory.TextStyle style; |
| | | if (desc.getLabelType() == LabelFieldDescriptor.LabelType.PRIMARY) |
| | |
| | | * @return a JTextComponent based on a |
| | | * LabelFieldDescriptor. |
| | | */ |
| | | static public JTextComponent makeJTextComponent(LabelFieldDescriptor desc, |
| | | public static JTextComponent makeJTextComponent(LabelFieldDescriptor desc, |
| | | String defaultValue) |
| | | { |
| | | if (defaultValue == null) |
| | |
| | | * @param but JButton for invoking browse action |
| | | * @return the created panel. |
| | | */ |
| | | static public JPanel createBrowseButtonPanel(JLabel lbl, |
| | | public static JPanel createBrowseButtonPanel(JLabel lbl, |
| | | JTextComponent tf, |
| | | JButton but) |
| | | { |
| | |
| | | * |
| | | * @param frame for which the icon will be set |
| | | */ |
| | | static public void setFrameIcon(JFrame frame) |
| | | public static void setFrameIcon(JFrame frame) |
| | | { |
| | | UIFactory.IconType ic; |
| | | if (isMacOS()) { |
| | |
| | | * @param child to act as the new file object |
| | | * @return FileOperation as the same type as this class |
| | | */ |
| | | abstract public FileOperation copyForChild(File child); |
| | | public abstract FileOperation copyForChild(File child); |
| | | |
| | | /** |
| | | * Execute this operation. |
| | | * @throws ApplicationException if there is a problem. |
| | | */ |
| | | abstract public void apply() throws ApplicationException; |
| | | public abstract void apply() throws ApplicationException; |
| | | |
| | | } |
| | | |
| | |
| | | * |
| | | * |
| | | * Copyright 2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2014 ForgeRock AS |
| | | * Portions Copyright 2014-2015 ForgeRock AS |
| | | */ |
| | | |
| | | package org.opends.quicksetup.util; |
| | |
| | | /** |
| | | * This class is used to read an input stream and process ouput. |
| | | */ |
| | | abstract public class OutputReader { |
| | | public abstract class OutputReader { |
| | | |
| | | private static final LocalizedLogger logger = LocalizedLogger.getLoggerForThisClass(); |
| | | |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2014 ForgeRock AS |
| | | * Portions Copyright 2014-2015 ForgeRock AS |
| | | */ |
| | | |
| | | package org.opends.quicksetup.util; |
| | |
| | | * representation |
| | | * @return the formatted representation for the given text. |
| | | */ |
| | | public LocalizableMessage getFormattedText(LocalizableMessage text); |
| | | LocalizableMessage getFormattedText(LocalizableMessage text); |
| | | |
| | | /** |
| | | * Returns the formatted representation of the text that is the summary of the |
| | |
| | | * representation |
| | | * @return the formatted representation of a summary for the given text. |
| | | */ |
| | | public LocalizableMessage getFormattedSummary(LocalizableMessage text); |
| | | LocalizableMessage getFormattedSummary(LocalizableMessage text); |
| | | |
| | | /** |
| | | * Returns the formatted representation of an error for a given text. |
| | |
| | | * resulting formatted text. |
| | | * @return the formatted representation of an error for the given text. |
| | | */ |
| | | public LocalizableMessage getFormattedError(LocalizableMessage text, boolean applyMargin); |
| | | LocalizableMessage getFormattedError(LocalizableMessage text, boolean applyMargin); |
| | | |
| | | /** |
| | | * Returns the formatted representation of a warning for a given text. |
| | |
| | | * resulting formatted text. |
| | | * @return the formatted representation of a warning for the given text. |
| | | */ |
| | | public LocalizableMessage getFormattedWarning(LocalizableMessage text, boolean applyMargin); |
| | | LocalizableMessage getFormattedWarning(LocalizableMessage text, boolean applyMargin); |
| | | |
| | | /** |
| | | * Returns the formatted representation of a success message for a given text. |
| | |
| | | * @return the formatted representation of a success message for the given |
| | | * text. |
| | | */ |
| | | public LocalizableMessage getFormattedSuccess(LocalizableMessage text); |
| | | LocalizableMessage getFormattedSuccess(LocalizableMessage text); |
| | | |
| | | /** |
| | | * Returns the formatted representation of a log error message for a given |
| | |
| | | * @return the formatted representation of a log error message for the given |
| | | * text. |
| | | */ |
| | | public LocalizableMessage getFormattedLogError(LocalizableMessage text); |
| | | LocalizableMessage getFormattedLogError(LocalizableMessage text); |
| | | |
| | | /** |
| | | * Returns the formatted representation of a log message for a given text. |
| | |
| | | * representation |
| | | * @return the formatted representation of a log message for the given text. |
| | | */ |
| | | public LocalizableMessage getFormattedLog(LocalizableMessage text); |
| | | LocalizableMessage getFormattedLog(LocalizableMessage text); |
| | | |
| | | /** |
| | | * Returns the formatted representation of the 'Done' text string. |
| | | * @return the formatted representation of the 'Done' text string. |
| | | */ |
| | | public LocalizableMessage getFormattedDone(); |
| | | LocalizableMessage getFormattedDone(); |
| | | |
| | | /** |
| | | * Returns the formatted representation of the 'Error' text string. |
| | | * @return the formatted representation of the 'Error' text string. |
| | | */ |
| | | public LocalizableMessage getFormattedError(); |
| | | LocalizableMessage getFormattedError(); |
| | | |
| | | /** |
| | | * Returns the formatted representation of the argument text to which we add |
| | |
| | | * @param text the String to which add points. |
| | | * @return the formatted representation of the '.....' text string. |
| | | */ |
| | | public LocalizableMessage getFormattedWithPoints(LocalizableMessage text); |
| | | |
| | | LocalizableMessage getFormattedWithPoints(LocalizableMessage text); |
| | | |
| | | /** |
| | | * Returns the formatted representation of a point. |
| | | * @return the formatted representation of the '.' text string. |
| | | */ |
| | | public LocalizableMessage getFormattedPoint(); |
| | | LocalizableMessage getFormattedPoint(); |
| | | |
| | | /** |
| | | * Returns the formatted representation of a space. |
| | | * @return the formatted representation of the ' ' text string. |
| | | */ |
| | | public LocalizableMessage getSpace(); |
| | | LocalizableMessage getSpace(); |
| | | |
| | | /** |
| | | * Returns the formatted representation of a progress message for a given |
| | |
| | | * @return the formatted representation of a progress message for the given |
| | | * text. |
| | | */ |
| | | public LocalizableMessage getFormattedProgress(LocalizableMessage text); |
| | | LocalizableMessage getFormattedProgress(LocalizableMessage text); |
| | | |
| | | /** |
| | | * Returns the formatted representation of an error message for a given |
| | |
| | | * @return the formatted representation of an error message for the given |
| | | * exception. |
| | | */ |
| | | public LocalizableMessage getFormattedError(Throwable t, boolean applyMargin); |
| | | LocalizableMessage getFormattedError(Throwable t, boolean applyMargin); |
| | | |
| | | /** |
| | | * Returns the line break formatted. |
| | | * @return the line break formatted. |
| | | */ |
| | | public LocalizableMessage getLineBreak(); |
| | | LocalizableMessage getLineBreak(); |
| | | |
| | | /** |
| | | * Returns the tab formatted. |
| | | * @return the tab formatted. |
| | | */ |
| | | public LocalizableMessage getTab(); |
| | | LocalizableMessage getTab(); |
| | | |
| | | /** |
| | | * Returns the task separator formatted. |
| | | * @return the task separator formatted. |
| | | */ |
| | | public LocalizableMessage getTaskSeparator(); |
| | | LocalizableMessage getTaskSeparator(); |
| | | |
| | | /** |
| | | * Returns the log formatted representation after the user has clicked on a |
| | |
| | | * @return the formatted progress log representation after the user has |
| | | * clicked on a url. |
| | | */ |
| | | public LocalizableMessage getFormattedAfterUrlClick(String url, LocalizableMessage lastText); |
| | | LocalizableMessage getFormattedAfterUrlClick(String url, LocalizableMessage lastText); |
| | | } |
| | |
| | | */ |
| | | public class StandardOutputSuppressor { |
| | | |
| | | static private Token token; |
| | | private static Token token; |
| | | |
| | | /** Object to return to this class for unsuppressing output. */ |
| | | static private class Token { |
| | | private static class Token { |
| | | PrintStream out; |
| | | PrintStream err; |
| | | } |
| | | |
| | | /** Suppresses output to the standard output streams. */ |
| | | static synchronized public void suppress() { |
| | | public static synchronized void suppress() { |
| | | if (token == null) { |
| | | token = new Token(); |
| | | token.out = System.out; |
| | |
| | | * method System.out and System.err will point to the descriptor prior |
| | | * to calling <code>suppress()</code>. |
| | | */ |
| | | static synchronized public void unsuppress() { |
| | | public static synchronized void unsuppress() { |
| | | if (token != null) { |
| | | System.setOut(token.out); |
| | | System.setErr(token.err); |
| | |
| | | * Checks whether or not this class has suppressed standard out streams. |
| | | * @return boolean where true indicates output is suppressed |
| | | */ |
| | | static public boolean isSuppressed() { |
| | | public static boolean isSuppressed() { |
| | | return token != null; |
| | | } |
| | | |
| | | /** |
| | | * PrintWriter for suppressing stream. |
| | | */ |
| | | static private class NullOutputStream extends OutputStream { |
| | | private static class NullOutputStream extends OutputStream { |
| | | |
| | | /** |
| | | * {@inheritDoc} |
| | | */ |
| | | /** {@inheritDoc} */ |
| | | public void write(int b) throws IOException { |
| | | // do nothing; |
| | | } |
| | | |
| | | } |
| | | |
| | | |
| | | } |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2010 Sun Microsystems, Inc. |
| | | * Portions Copyright 2011-2014 ForgeRock AS |
| | | * Portions Copyright 2011-2015 ForgeRock AS |
| | | */ |
| | | package org.opends.quicksetup.util; |
| | | |
| | |
| | | |
| | | |
| | | /** The service name required by the JNLP downloader. */ |
| | | public final static String JNLP_SERVICE_NAME = "javax.jnlp.DownloadService"; |
| | | public static final String JNLP_SERVICE_NAME = "javax.jnlp.DownloadService"; |
| | | |
| | | /** |
| | | * Returns <CODE>true</CODE> if the provided port is free and we can use it, |
| | |
| | | * |
| | | * |
| | | * Copyright 2007-2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2011-2014 ForgeRock AS |
| | | * Portions Copyright 2011-2015 ForgeRock AS |
| | | */ |
| | | |
| | | package org.opends.quicksetup.util; |
| | |
| | | private static final LocalizedLogger logger = LocalizedLogger.getLoggerForThisClass(); |
| | | |
| | | /** Path separator for zip file entry names on Windows and *nix. */ |
| | | static private final char ZIP_ENTRY_NAME_SEP = '/'; |
| | | private static final char ZIP_ENTRY_NAME_SEP = '/'; |
| | | |
| | | private InputStream is; |
| | | private int minRatio; |
| | |
| | | * |
| | | * |
| | | * Copyright 2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2014 ForgeRock AS |
| | | * Portions Copyright 2014-2015 ForgeRock AS |
| | | */ |
| | | |
| | | package org.opends.server.admin; |
| | |
| | | |
| | | |
| | | // Get a resource instance creating it if necessary. |
| | | private synchronized static ManagedObjectDefinitionI18NResource getInstance( |
| | | private static synchronized ManagedObjectDefinitionI18NResource getInstance( |
| | | String prefix) { |
| | | ManagedObjectDefinitionI18NResource instance = INSTANCES |
| | | .get(prefix); |
| | | ManagedObjectDefinitionI18NResource instance = INSTANCES.get(prefix); |
| | | |
| | | if (instance == null) { |
| | | instance = new ManagedObjectDefinitionI18NResource(prefix); |
| | |
| | | * |
| | | * |
| | | * Copyright 2008-2009 Sun Microsystems, Inc. |
| | | * Portions Copyright 2011-2014 ForgeRock AS |
| | | * Portions Copyright 2011-2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.admin; |
| | | |
| | |
| | | extends Element<C, S> { |
| | | |
| | | // Factory method. |
| | | private static final <C extends ConfigurationClient, |
| | | private static <C extends ConfigurationClient, |
| | | S extends Configuration> |
| | | InstantiableElement<C, S> create( |
| | | InstantiableRelationDefinition<? super C, ? super S> r, |
| | |
| | | extends Element<C, S> { |
| | | |
| | | // Factory method. |
| | | private static final <C extends ConfigurationClient, |
| | | private static <C extends ConfigurationClient, |
| | | S extends Configuration> OptionalElement<C, S> create( |
| | | OptionalRelationDefinition<? super C, ? super S> r, |
| | | AbstractManagedObjectDefinition<C, S> d) { |
| | |
| | | extends Element<C, S> { |
| | | |
| | | // Factory method. |
| | | private static final <C extends ConfigurationClient, |
| | | private static <C extends ConfigurationClient, |
| | | S extends Configuration> |
| | | SetElement<C, S> create( |
| | | SetRelationDefinition<? super C, ? super S> r, |
| | |
| | | extends Element<C, S> { |
| | | |
| | | // Factory method. |
| | | private static final <C extends ConfigurationClient, |
| | | private static <C extends ConfigurationClient, |
| | | S extends Configuration> SingletonElement<C, S> create( |
| | | SingletonRelationDefinition<? super C, ? super S> r, |
| | | AbstractManagedObjectDefinition<C, S> d) { |
| | |
| | | * |
| | | * |
| | | * Copyright 2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2014 ForgeRock AS |
| | | * Portions Copyright 2014-2015 ForgeRock AS |
| | | */ |
| | | |
| | | package org.opends.server.admin; |
| | |
| | | * The type of property definition constructed by this |
| | | * builder. |
| | | */ |
| | | protected abstract static class AbstractBuilder |
| | | protected static abstract class AbstractBuilder |
| | | <T, D extends PropertyDefinition<T>> { |
| | | |
| | | // The administrator action. |
| | |
| | | * |
| | | * |
| | | * Copyright 2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2015 ForgeRock AS |
| | | */ |
| | | |
| | | package org.opends.server.admin; |
| | |
| | | * A property provider which always returns empty property values, indicating |
| | | * default behavior. |
| | | */ |
| | | public static final PropertyProvider DEFAULT_PROVIDER = |
| | | PropertyProvider DEFAULT_PROVIDER = |
| | | new PropertyProvider() { |
| | | |
| | | /** |
| | |
| | | * |
| | | * |
| | | * Copyright 2008-2009 Sun Microsystems, Inc. |
| | | * Portions Copyright 2014 ForgeRock AS |
| | | * Portions Copyright 2014-2015 ForgeRock AS |
| | | */ |
| | | |
| | | package org.opends.server.admin; |
| | |
| | | * The type of relation definition constructed by this |
| | | * builder. |
| | | */ |
| | | protected abstract static class AbstractBuilder |
| | | protected static abstract class AbstractBuilder |
| | | <C extends ConfigurationClient, S extends Configuration, |
| | | D extends RelationDefinition<C, S>> { |
| | | |
| | |
| | | // Note : still to be done : |
| | | // I18n support. Today all the strings are hardcoded in this file |
| | | |
| | | private final static String ACI_SYNTAX_REL_URL = |
| | | private static final String ACI_SYNTAX_REL_URL = |
| | | "/doc/admin-guide/#about-acis"; |
| | | private final static String DURATION_SYNTAX_REL_URL = |
| | | private static final String DURATION_SYNTAX_REL_URL = |
| | | "duration-syntax.html"; |
| | | private final String CSS_FILE = "opendj-config.css"; |
| | | |
| | |
| | | * @return Returns <code>true</code> if the proposed addition is |
| | | * acceptable, or <code>false</code> if it is not. |
| | | */ |
| | | public boolean isConfigurationAddAcceptable(T configuration, |
| | | boolean isConfigurationAddAcceptable(T configuration, |
| | | List<LocalizableMessage> unacceptableReasons); |
| | | |
| | | |
| | |
| | | * @return Returns information about the result of adding the |
| | | * configuration. |
| | | */ |
| | | public ConfigChangeResult applyConfigurationAdd(T configuration); |
| | | ConfigChangeResult applyConfigurationAdd(T configuration); |
| | | } |
| | |
| | | * @return Returns <code>true</code> if the proposed change is |
| | | * acceptable, or <code>false</code> if it is not. |
| | | */ |
| | | public boolean isConfigurationChangeAcceptable(T configuration, |
| | | boolean isConfigurationChangeAcceptable(T configuration, |
| | | List<LocalizableMessage> unacceptableReasons); |
| | | |
| | | /** |
| | |
| | | * @return Returns information about the result of changing the |
| | | * configuration. |
| | | */ |
| | | public ConfigChangeResult applyConfigurationChange(T configuration); |
| | | ConfigChangeResult applyConfigurationChange(T configuration); |
| | | } |
| | |
| | | * @return Returns <code>true</code> if the proposed deletion is |
| | | * acceptable, or <code>false</code> if it is not. |
| | | */ |
| | | public boolean isConfigurationDeleteAcceptable(T configuration, |
| | | boolean isConfigurationDeleteAcceptable(T configuration, |
| | | List<LocalizableMessage> unacceptableReasons); |
| | | |
| | | |
| | |
| | | * @return Returns information about the result of deleting the |
| | | * configuration. |
| | | */ |
| | | public ConfigChangeResult applyConfigurationDelete(T configuration); |
| | | ConfigChangeResult applyConfigurationDelete(T configuration); |
| | | } |
| | |
| | | * @return Returns <code>true</code> if the proposed addition is |
| | | * acceptable, or <code>false</code> if it is not. |
| | | */ |
| | | public boolean isConfigurationAddAcceptable( |
| | | boolean isConfigurationAddAcceptable( |
| | | ServerManagedObject<? extends T> mo, List<LocalizableMessage> unacceptableReasons); |
| | | |
| | | |
| | |
| | | * @return Returns information about the result of adding the server |
| | | * managed object. |
| | | */ |
| | | public ConfigChangeResult applyConfigurationAdd( |
| | | ConfigChangeResult applyConfigurationAdd( |
| | | ServerManagedObject<? extends T> mo); |
| | | } |
| | |
| | | * @return Returns <code>true</code> if the proposed change is |
| | | * acceptable, or <code>false</code> if it is not. |
| | | */ |
| | | public boolean isConfigurationChangeAcceptable( |
| | | boolean isConfigurationChangeAcceptable( |
| | | ServerManagedObject<? extends T> mo, List<LocalizableMessage> unacceptableReasons); |
| | | |
| | | |
| | |
| | | * @return Returns information about the result of changing the |
| | | * server managed object. |
| | | */ |
| | | public ConfigChangeResult applyConfigurationChange(ServerManagedObject<? extends T> mo); |
| | | ConfigChangeResult applyConfigurationChange(ServerManagedObject<? extends T> mo); |
| | | } |
| | |
| | | * @return Returns <code>true</code> if the proposed deletion is |
| | | * acceptable, or <code>false</code> if it is not. |
| | | */ |
| | | public boolean isConfigurationDeleteAcceptable( |
| | | boolean isConfigurationDeleteAcceptable( |
| | | ServerManagedObject<? extends T> mo, List<LocalizableMessage> unacceptableReasons); |
| | | |
| | | |
| | |
| | | * @return Returns information about the result of deleting the |
| | | * server managed object. |
| | | */ |
| | | public ConfigChangeResult applyConfigurationDelete( |
| | | ConfigChangeResult applyConfigurationDelete( |
| | | ServerManagedObject<? extends T> mo); |
| | | } |
| | |
| | | |
| | | |
| | | // Singleton instance. |
| | | private final static ServerManagementContext INSTANCE = |
| | | private static final ServerManagementContext INSTANCE = |
| | | new ServerManagementContext(); |
| | | |
| | | /** |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2013 ForgeRock AS |
| | | * Portions Copyright 2013-2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.api; |
| | | |
| | |
| | | * @return The DN of the configuration entry with which this alert |
| | | * generator is associated. |
| | | */ |
| | | public DN getComponentEntryDN(); |
| | | DN getComponentEntryDN(); |
| | | |
| | | |
| | | |
| | |
| | | * @return The fully-qualified name of the Java class for this |
| | | * alert generator implementation. |
| | | */ |
| | | public String getClassName(); |
| | | String getClassName(); |
| | | |
| | | |
| | | |
| | |
| | | * @return Information about the set of alerts that this generator |
| | | * may produce. |
| | | */ |
| | | public Map<String, String> getAlerts(); |
| | | Map<String, String> getAlerts(); |
| | | } |
| | | |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2014 ForgeRock AS |
| | | * Portions Copyright 2014-2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.api; |
| | | import org.forgerock.i18n.LocalizableMessage; |
| | |
| | | * related to the server |
| | | * configuration. |
| | | */ |
| | | public void initializeAlertHandler(T configuration) |
| | | void initializeAlertHandler(T configuration) |
| | | throws ConfigException, InitializationException; |
| | | |
| | | |
| | |
| | | * |
| | | * @return The current configuration for this alert handler. |
| | | */ |
| | | public AlertHandlerCfg getAlertHandlerConfiguration(); |
| | | AlertHandlerCfg getAlertHandlerConfiguration(); |
| | | |
| | | |
| | | |
| | |
| | | * @return {@code true} if the provided configuration is |
| | | * acceptable, or {@code false} if it is not. |
| | | */ |
| | | public boolean isConfigurationAcceptable( |
| | | boolean isConfigurationAcceptable( |
| | | AlertHandlerCfg configuration, |
| | | List<LocalizableMessage> unacceptableReasons); |
| | | |
| | |
| | | * Performs any necessary cleanup that may be necessary when this |
| | | * alert handler is finalized. |
| | | */ |
| | | public void finalizeAlertHandler(); |
| | | void finalizeAlertHandler(); |
| | | |
| | | |
| | | |
| | |
| | | * @param alertMessage A message (possibly {@code null}) that can |
| | | * provide more information about this alert. |
| | | */ |
| | | public void sendAlertNotification(AlertGenerator generator, |
| | | void sendAlertNotification(AlertGenerator generator, |
| | | String alertType, |
| | | LocalizableMessage alertMessage); |
| | | } |
| | |
| | | * CDDL HEADER END |
| | | * |
| | | * |
| | | * Portions Copyright 2011-2014 ForgeRock AS. |
| | | * Portions Copyright 2011-2015 ForgeRock AS. |
| | | * Portions Copyright 2014 ForgeRock AS |
| | | */ |
| | | package org.opends.server.api; |
| | |
| | | * If a problem occurs while attempting to determine the password |
| | | * policy for the user. |
| | | */ |
| | | public final static AuthenticationPolicy forUser(Entry userEntry, |
| | | public static AuthenticationPolicy forUser(Entry userEntry, |
| | | boolean useDefaultOnError) throws DirectoryException |
| | | { |
| | | // First check to see if the ds-pwp-password-policy-dn is present. |
| | |
| | | * CDDL HEADER END |
| | | * |
| | | * |
| | | * Portions Copyright 2011-2014 ForgeRock AS. |
| | | * Portions Copyright 2011-2015 ForgeRock AS. |
| | | */ |
| | | |
| | | package org.opends.server.api; |
| | |
| | | * @param serverContext |
| | | * The server context. |
| | | */ |
| | | void setServerContext(final ServerContext serverContext); |
| | | void setServerContext(ServerContext serverContext); |
| | | |
| | | } |
| | |
| | | * CDDL HEADER END |
| | | * |
| | | * |
| | | * Portions Copyright 2011-2014 ForgeRock AS. |
| | | * Portions Copyright 2011-2015 ForgeRock AS. |
| | | * Portions Copyright 2014 ForgeRock AS |
| | | */ |
| | | package org.opends.server.api; |
| | |
| | | * policy for the user. |
| | | * @see AuthenticationPolicy#forUser(Entry, boolean) |
| | | */ |
| | | public final static AuthenticationPolicyState forUser(final Entry userEntry, |
| | | public static AuthenticationPolicyState forUser(final Entry userEntry, |
| | | final boolean useDefaultOnError) throws DirectoryException |
| | | { |
| | | final AuthenticationPolicy policy = AuthenticationPolicy.forUser(userEntry, |
| | |
| | | * @throws DirectoryException |
| | | * If the value cannot be decoded as a boolean. |
| | | */ |
| | | protected static final ConditionResult getBoolean(final Entry entry, |
| | | protected static ConditionResult getBoolean(final Entry entry, |
| | | final AttributeType attributeType) throws DirectoryException |
| | | { |
| | | final List<Attribute> attrList = entry.getAttribute(attributeType); |
| | |
| | | * If a problem occurs while attempting to decode the value as a |
| | | * generalized time. |
| | | */ |
| | | protected static final long getGeneralizedTime(final Entry entry, |
| | | protected static long getGeneralizedTime(final Entry entry, |
| | | final AttributeType attributeType) throws DirectoryException |
| | | { |
| | | long timeValue = -1; |
| | |
| | | * @return {@code true} if the backend should handle operations for |
| | | * the provided entry, or {@code false} if it does not. |
| | | */ |
| | | public static final boolean handlesEntry(DN entryDN, Collection<DN> baseDNs, Collection<DN> excludeDNs) |
| | | public static boolean handlesEntry(DN entryDN, Collection<DN> baseDNs, Collection<DN> excludeDNs) |
| | | { |
| | | for (DN baseDN : baseDNs) |
| | | { |
| | |
| | | * |
| | | * |
| | | * Copyright 2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.api; |
| | | |
| | |
| | | * @param backend The backend that has been initialized and is |
| | | * about to be put into service. |
| | | */ |
| | | public void performBackendInitializationProcessing(Backend backend); |
| | | void performBackendInitializationProcessing(Backend backend); |
| | | |
| | | |
| | | |
| | |
| | | * @param backend The backend that has been taken out of service |
| | | * and is about to be finalized. |
| | | */ |
| | | public void performBackendFinalizationProcessing(Backend backend); |
| | | void performBackendFinalizationProcessing(Backend backend); |
| | | } |
| | | |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.api; |
| | | |
| | |
| | | * @param config Configuration information about the backup to be |
| | | * performed. |
| | | */ |
| | | public void processBackupBegin(Backend backend, |
| | | void processBackupBegin(Backend backend, |
| | | BackupConfig config); |
| | | |
| | | |
| | |
| | | * @param successful Indicates whether the backup operation |
| | | * completed successfully. |
| | | */ |
| | | public void processBackupEnd(Backend backend, BackupConfig config, |
| | | void processBackupEnd(Backend backend, BackupConfig config, |
| | | boolean successful); |
| | | } |
| | | |
| | |
| | | * acceptable configuration, or {@code false} if it does |
| | | * not. |
| | | */ |
| | | public boolean configAddIsAcceptable(ConfigEntry configEntry, |
| | | boolean configAddIsAcceptable(ConfigEntry configEntry, |
| | | LocalizableMessageBuilder unacceptableReason); |
| | | |
| | | /** |
| | |
| | | * @return Information about the result of processing the |
| | | * configuration change. |
| | | */ |
| | | public ConfigChangeResult applyConfigurationAdd(ConfigEntry configEntry); |
| | | ConfigChangeResult applyConfigurationAdd(ConfigEntry configEntry); |
| | | } |
| | |
| | | * acceptable configuration, or {@code false} if it does |
| | | * not. |
| | | */ |
| | | public boolean configChangeIsAcceptable(ConfigEntry configEntry, |
| | | boolean configChangeIsAcceptable(ConfigEntry configEntry, |
| | | LocalizableMessageBuilder unacceptableReason); |
| | | |
| | | |
| | |
| | | * @return Information about the result of processing the |
| | | * configuration change. |
| | | */ |
| | | public ConfigChangeResult applyConfigurationChange( |
| | | ConfigChangeResult applyConfigurationChange( |
| | | ConfigEntry configEntry); |
| | | } |
| | | |
| | |
| | | * @return {@code true} if the proposed entry may be removed from |
| | | * the configuration, or {@code false} if not. |
| | | */ |
| | | public boolean configDeleteIsAcceptable(ConfigEntry configEntry, |
| | | boolean configDeleteIsAcceptable(ConfigEntry configEntry, |
| | | LocalizableMessageBuilder unacceptableReason); |
| | | |
| | | |
| | |
| | | * @return Information about the result of processing the |
| | | * configuration change. |
| | | */ |
| | | public ConfigChangeResult applyConfigurationDelete( |
| | | ConfigEntry configEntry); |
| | | ConfigChangeResult applyConfigurationDelete(ConfigEntry configEntry); |
| | | } |
| | | |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.api; |
| | | |
| | | |
| | | |
| | | import javax.management.ObjectName; |
| | | |
| | | |
| | | |
| | | /** |
| | | * This interface must be implemented by all Directory Server |
| | | * components that interact with JMX in any way. |
| | |
| | | * |
| | | * @return The JMX object name for this MBean. |
| | | */ |
| | | public ObjectName getObjectName(); |
| | | ObjectName getObjectName(); |
| | | } |
| | | |
| | |
| | | * |
| | | * |
| | | * Copyright 2010 Sun Microsystems, Inc. |
| | | * Portions Copyright 2015 ForgeRock AS |
| | | */ |
| | | |
| | | package org.opends.server.api; |
| | |
| | | * |
| | | * @param monitor The DiskSpaceMonitor that detected this event. |
| | | */ |
| | | public void diskLowThresholdReached(DiskSpaceMonitor monitor); |
| | | void diskLowThresholdReached(DiskSpaceMonitor monitor); |
| | | |
| | | /** |
| | | * Notifies that the registered "full" threshold have been reached. |
| | | * |
| | | * @param monitor The DiskSpaceMonitor that detected this event. |
| | | */ |
| | | public void diskFullThresholdReached(DiskSpaceMonitor monitor); |
| | | void diskFullThresholdReached(DiskSpaceMonitor monitor); |
| | | |
| | | /** |
| | | * Notifies that the free disk space is now above both "low" and |
| | |
| | | * |
| | | * @param monitor The DiskSpaceMonitor that detected this event. |
| | | */ |
| | | public void diskSpaceRestored(DiskSpaceMonitor monitor); |
| | | void diskSpaceRestored(DiskSpaceMonitor monitor); |
| | | } |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.api; |
| | | |
| | |
| | | * @param config Configuration information about the LDIF export |
| | | * to be performed. |
| | | */ |
| | | public void processExportBegin(Backend backend, |
| | | void processExportBegin(Backend backend, |
| | | LDIFExportConfig config); |
| | | |
| | | |
| | |
| | | * @param successful Indicates whether the export operation |
| | | * completed successfully. |
| | | */ |
| | | public void processExportEnd(Backend backend, |
| | | void processExportEnd(Backend backend, |
| | | LDIFExportConfig config, |
| | | boolean successful); |
| | | } |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.api; |
| | | |
| | |
| | | * @param config Configuration information about the LDIF import |
| | | * to be performed. |
| | | */ |
| | | public void processImportBegin(Backend backend, |
| | | void processImportBegin(Backend backend, |
| | | LDIFImportConfig config); |
| | | |
| | | |
| | |
| | | * @param successful Indicates whether the import operation |
| | | * completed successfully. |
| | | */ |
| | | public void processImportEnd(Backend backend, |
| | | void processImportEnd(Backend backend, |
| | | LDIFImportConfig config, |
| | | boolean successful); |
| | | } |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.api; |
| | | |
| | |
| | | * Callback that is executed once the server |
| | | * initialization is complete. |
| | | */ |
| | | public void initializationCompleted(); |
| | | void initializationCompleted(); |
| | | } |
| | | |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.api; |
| | | |
| | |
| | | * @return The DN of the configuration entry with which this |
| | | * component is associated. |
| | | */ |
| | | public DN getInvokableComponentEntryDN(); |
| | | DN getInvokableComponentEntryDN(); |
| | | |
| | | |
| | | |
| | |
| | | * @return A list of the methods that may be invoked for this |
| | | * component. |
| | | */ |
| | | public InvokableMethod[] getOperationSignatures(); |
| | | InvokableMethod[] getOperationSignatures(); |
| | | |
| | | |
| | | |
| | |
| | | * an error occurred while attempting |
| | | * to invoke it. |
| | | */ |
| | | public Object invokeMethod(String methodName, |
| | | ConfigAttribute[] arguments) |
| | | Object invokeMethod(String methodName, ConfigAttribute[] arguments) |
| | | throws DirectoryException; |
| | | } |
| | | |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.api; |
| | | |
| | |
| | | * @return The name of the protocol associated with this protocol |
| | | * element. |
| | | */ |
| | | public String getProtocolElementName(); |
| | | String getProtocolElementName(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return A string representation of this protocol element. |
| | | */ |
| | | public String toString(); |
| | | String toString(); |
| | | |
| | | |
| | | |
| | |
| | | * @param buffer The buffer into which the string representation |
| | | * should be written. |
| | | */ |
| | | public void toString(StringBuilder buffer); |
| | | void toString(StringBuilder buffer); |
| | | |
| | | |
| | | |
| | |
| | | * @param indent The number of spaces that should be used to |
| | | * indent the resulting string representation. |
| | | */ |
| | | public void toString(StringBuilder buffer, int indent); |
| | | void toString(StringBuilder buffer, int indent); |
| | | } |
| | | |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.api; |
| | | |
| | |
| | | * @param config Configuration information about the restore to |
| | | * be performed. |
| | | */ |
| | | public void processRestoreBegin(Backend backend, |
| | | void processRestoreBegin(Backend backend, |
| | | RestoreConfig config); |
| | | |
| | | |
| | |
| | | * @param successful Indicates whether the restore operation |
| | | * completed successfully. |
| | | */ |
| | | public void processRestoreEnd(Backend backend, RestoreConfig config, |
| | | void processRestoreEnd(Backend backend, RestoreConfig config, |
| | | boolean successful); |
| | | } |
| | | |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2014 ForgeRock AS |
| | | * Portions Copyright 2014-2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.api; |
| | | import org.forgerock.i18n.LocalizableMessage; |
| | |
| | | * |
| | | * @return The human-readable name for this shutdown listener. |
| | | */ |
| | | public String getShutdownListenerName(); |
| | | String getShutdownListenerName(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @param reason The human-readable reason for the shutdown. |
| | | */ |
| | | public void processServerShutdown(LocalizableMessage reason); |
| | | void processServerShutdown(LocalizableMessage reason); |
| | | } |
| | | |
| | |
| | | * |
| | | * |
| | | * Copyright 2010 Sun Microsystems, Inc. |
| | | * Portions Copyright 2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.api; |
| | | |
| | |
| | | * @throws DirectoryException if operation is not |
| | | * acceptable for this subentry. |
| | | */ |
| | | public void checkSubentryAddAcceptable(Entry entry) |
| | | void checkSubentryAddAcceptable(Entry entry) |
| | | throws DirectoryException; |
| | | |
| | | /** |
| | |
| | | * @throws DirectoryException if operation is not |
| | | * acceptable for this subentry. |
| | | */ |
| | | public void checkSubentryDeleteAcceptable(Entry entry) |
| | | void checkSubentryDeleteAcceptable(Entry entry) |
| | | throws DirectoryException; |
| | | |
| | | /** |
| | |
| | | * @throws DirectoryException if operation is not |
| | | * acceptable for this subentry. |
| | | */ |
| | | public void checkSubentryModifyAcceptable(Entry oldEntry, |
| | | void checkSubentryModifyAcceptable(Entry oldEntry, |
| | | Entry newEntry) throws DirectoryException; |
| | | |
| | | /** |
| | |
| | | * @throws DirectoryException if operation is not |
| | | * acceptable for this subentry. |
| | | */ |
| | | public void checkSubentryModifyDNAcceptable(Entry oldEntry, |
| | | void checkSubentryModifyDNAcceptable(Entry oldEntry, |
| | | Entry newEntry) throws DirectoryException; |
| | | |
| | | /** |
| | |
| | | * @param entry The subentry that was added to the |
| | | * server. |
| | | */ |
| | | public void handleSubentryAdd(Entry entry); |
| | | void handleSubentryAdd(Entry entry); |
| | | |
| | | /** |
| | | * Performs any processing that may be required after a |
| | |
| | | * @param entry The subentry that was removed from the |
| | | * server. |
| | | */ |
| | | public void handleSubentryDelete(Entry entry); |
| | | void handleSubentryDelete(Entry entry); |
| | | |
| | | /** |
| | | * Performs any processing that may be required after a |
| | |
| | | * @param oldEntry The subentry before it was updated. |
| | | * @param newEntry The subentry after it was updated. |
| | | */ |
| | | public void handleSubentryModify(Entry oldEntry, Entry newEntry); |
| | | void handleSubentryModify(Entry oldEntry, Entry newEntry); |
| | | |
| | | /** |
| | | * Performs any processing that may be required after a |
| | |
| | | * @param oldEntry The subentry before it was updated. |
| | | * @param newEntry The subentry after it was updated. |
| | | */ |
| | | public void handleSubentryModifyDN(Entry oldEntry, Entry newEntry); |
| | | void handleSubentryModifyDN(Entry oldEntry, Entry newEntry); |
| | | } |
| | |
| | | * |
| | | * |
| | | * Copyright 2008-2010 Sun Microsystems, Inc. |
| | | * Portions Copyright 2011 ForgeRock AS |
| | | * Portions Copyright 2011-2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.authorization.dseecompat; |
| | | |
| | |
| | | * Get client DN. The client DN is the authorization DN. |
| | | * @return The client DN. |
| | | */ |
| | | public DN getClientDN(); |
| | | DN getClientDN(); |
| | | |
| | | /** |
| | | * Get the client entry. The client entry is the entry that corresponds |
| | | * to the client DN. |
| | | * @return The client entry corresponding to the client DN. |
| | | */ |
| | | public Entry getClientEntry(); |
| | | Entry getClientEntry(); |
| | | |
| | | /** |
| | | * Get the resource DN. The resource DN is the DN of the entry being |
| | | * evaluated. |
| | | * @return The resource DN. |
| | | */ |
| | | public DN getResourceDN(); |
| | | DN getResourceDN(); |
| | | |
| | | /** |
| | | * Get the list of deny ACIs. |
| | | * @return The deny ACI list. |
| | | */ |
| | | public List<Aci> getDenyList(); |
| | | List<Aci> getDenyList(); |
| | | |
| | | /** |
| | | * Get the list allow ACIs. |
| | | * @return The allow ACI list. |
| | | */ |
| | | public List<Aci> getAllowList(); |
| | | List<Aci> getAllowList(); |
| | | |
| | | /** |
| | | * Returns true if the deny list is being evaluated. |
| | | * @return True if the deny list is being evaluated. |
| | | */ |
| | | public boolean isDenyEval(); |
| | | boolean isDenyEval(); |
| | | |
| | | /** |
| | | * Check if the remote client is bound anonymously. |
| | | * @return {@code true} if client is bound anonymously. |
| | | */ |
| | | public boolean isAnonymousUser(); |
| | | boolean isAnonymousUser(); |
| | | |
| | | /** |
| | | * Return the rights set for this container's LDAP operation. |
| | | * @return The rights set for the container's LDAP operation. |
| | | */ |
| | | public int getRights(); |
| | | int getRights(); |
| | | |
| | | /** |
| | | * Return the entry being evaluated |
| | | * . |
| | | * @return The evaluation entry. |
| | | */ |
| | | public Entry getResourceEntry(); |
| | | Entry getResourceEntry(); |
| | | |
| | | /** |
| | | * Get the hostname of the bound connection. |
| | | * @return The hostname of the connection. |
| | | */ |
| | | public String getHostName(); |
| | | String getHostName(); |
| | | |
| | | /** |
| | | * Determine whether the client connection has been authenticated using |
| | |
| | | * @return An evaluation result indicating whether the client connection |
| | | * has been authenticated using the required authentication method. |
| | | */ |
| | | public EnumEvalResult hasAuthenticationMethod(EnumAuthMethod authMethod, |
| | | EnumEvalResult hasAuthenticationMethod(EnumAuthMethod authMethod, |
| | | String saslMech); |
| | | |
| | | /** |
| | | * Get the address of the bound connection. |
| | | * @return The address of the bound connection. |
| | | */ |
| | | public InetAddress getRemoteAddress(); |
| | | InetAddress getRemoteAddress(); |
| | | |
| | | /** |
| | | * Return true if this is an add operation needed by the userattr |
| | |
| | | * |
| | | * @return {@code true} if this is an add operation. |
| | | */ |
| | | public boolean isAddOperation(); |
| | | boolean isAddOperation(); |
| | | |
| | | /** |
| | | * Return true if the operation associated with this evaluation |
| | |
| | | * @return {@code true} if the authorization DN of the operation is a |
| | | * member of the specified group. |
| | | */ |
| | | public boolean isMemberOf(Group<?> group); |
| | | boolean isMemberOf(Group<?> group); |
| | | |
| | | /** |
| | | * Returns true if the hashtable of ACIs that matched the targattrfilters |
| | |
| | | * @return {@code true} if there were not any ACIs that matched |
| | | * targattrfilters keyword evaluation. |
| | | */ |
| | | public boolean isTargAttrFilterMatchAciEmpty(); |
| | | boolean isTargAttrFilterMatchAciEmpty(); |
| | | |
| | | /** |
| | | * The context maintains a hashtable of ACIs that matched the targattrfilters |
| | |
| | | * |
| | | * @return {@code true} if a specified ACI matched targattrfilters evaluation. |
| | | */ |
| | | public boolean hasTargAttrFiltersMatchAci(Aci aci); |
| | | boolean hasTargAttrFiltersMatchAci(Aci aci); |
| | | |
| | | /** |
| | | * Return true if an ACI that evaluated to deny or allow has an |
| | |
| | | * |
| | | * @return {@code true} if the ACI has an targattrfilters keyword. |
| | | */ |
| | | public boolean hasTargAttrFiltersMatchOp(int flag); |
| | | boolean hasTargAttrFiltersMatchOp(int flag); |
| | | |
| | | /** |
| | | * Returns {@code true} if the evaluation context is being used in a |
| | |
| | | * @return {@code true} if the evaluation context is being used in a |
| | | * geteffectiverights control evaluation. |
| | | */ |
| | | public boolean isGetEffectiveRightsEval(); |
| | | boolean isGetEffectiveRightsEval(); |
| | | |
| | | /** |
| | | * Set the name of the ACI that last matched a targattrfilters rule. Used |
| | |
| | | * |
| | | * @param name The ACI name string matching the targattrfilters rule. |
| | | */ |
| | | public void setTargAttrFiltersAciName(String name); |
| | | void setTargAttrFiltersAciName(String name); |
| | | |
| | | /** |
| | | * Set a flag that specifies that a ACI that evaluated to either deny or |
| | |
| | | * @param flag Either the integer value representing an allow or a deny, |
| | | * but not both. |
| | | */ |
| | | public void setTargAttrFiltersMatchOp(int flag); |
| | | void setTargAttrFiltersMatchOp(int flag); |
| | | |
| | | /** |
| | | * Set the reason and the ACI that decided why the last access evaluation was |
| | |
| | | * @return The enumeration representing the reason of the last access |
| | | * evaluation. |
| | | */ |
| | | public EnumEvalReason getEvalReason(); |
| | | EnumEvalReason getEvalReason(); |
| | | |
| | | /** |
| | | * Check if an evaluation context contains a set of access rights. |
| | |
| | | * |
| | | * @return {@code true} if the evaluation context contains a access right set. |
| | | */ |
| | | public boolean hasRights(int rights); |
| | | boolean hasRights(int rights); |
| | | |
| | | /** |
| | | * Return the name of the ACI that decided the last access evaluation. Used |
| | |
| | | * |
| | | * @return The name of the ACI that decided the last access evaluation. |
| | | */ |
| | | public String getDecidingAciName(); |
| | | String getDecidingAciName(); |
| | | |
| | | /** |
| | | * Return true if a evaluation context is being used in proxied authorization |
| | |
| | | * @return {@code true} if evaluation context is being used in proxied |
| | | * authorization control evaluation. |
| | | */ |
| | | public boolean isProxiedAuthorization(); |
| | | boolean isProxiedAuthorization(); |
| | | |
| | | /** |
| | | * Get the current attribute type being evaluated. |
| | | * |
| | | * @return The attribute type currently being evaluated. |
| | | */ |
| | | public AttributeType getCurrentAttributeType(); |
| | | AttributeType getCurrentAttributeType(); |
| | | |
| | | /** |
| | | * Set the value of the summary string to the specified string. |
| | |
| | | * |
| | | * @param summary The string to set the summary string to |
| | | */ |
| | | public void setEvalSummary(String summary); |
| | | void setEvalSummary(String summary); |
| | | |
| | | /** |
| | | * Return the access evaluation summary string. Used in a geteffectiverights |
| | |
| | | * |
| | | * @return The string describing the access evaluation. |
| | | */ |
| | | public String getEvalSummary(); |
| | | String getEvalSummary(); |
| | | |
| | | /** |
| | | * Return a string representation of the current right being evaluated. |
| | |
| | | * |
| | | * @return String representation of the current right being evaluated. |
| | | */ |
| | | public String rightToString(); |
| | | String rightToString(); |
| | | |
| | | /** |
| | | * Return the name of the ACI that last matched a targattrfilters rule. Used |
| | |
| | | * |
| | | * @return The name of the ACI that last matched a targattrfilters rule. |
| | | */ |
| | | public String getTargAttrFiltersAciName(); |
| | | String getTargAttrFiltersAciName(); |
| | | |
| | | |
| | | /** |
| | |
| | | * |
| | | * @return The current SSF of the connection. |
| | | */ |
| | | public int getCurrentSSF(); |
| | | int getCurrentSSF(); |
| | | } |
| | |
| | | * |
| | | * |
| | | * Copyright 2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2014 ForgeRock AS |
| | | * Portions Copyright 2014-2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.authorization.dseecompat; |
| | | |
| | |
| | | * Set the deny ACI list. |
| | | * @param denyList The deny ACI list. |
| | | */ |
| | | public void setDenyList(List<Aci> denyList); |
| | | void setDenyList(List<Aci> denyList); |
| | | |
| | | /** |
| | | * Set the allow ACI list. |
| | | * @param allowList The list of allow ACIs. |
| | | */ |
| | | public void setAllowList(List<Aci> allowList); |
| | | void setAllowList(List<Aci> allowList); |
| | | |
| | | /** |
| | | * Get the entry being evaluated. This is known as the |
| | | * resource entry. |
| | | * @return The entry being evaluated. |
| | | */ |
| | | public Entry getResourceEntry(); |
| | | Entry getResourceEntry(); |
| | | |
| | | /** |
| | | * Get the current attribute type being evaluated. |
| | | * @return The attribute type being evaluated. |
| | | */ |
| | | public AttributeType getCurrentAttributeType(); |
| | | AttributeType getCurrentAttributeType(); |
| | | |
| | | /** |
| | | * The current attribute type value being evaluated. |
| | | * @return The current attribute type value being evaluated. |
| | | */ |
| | | public ByteString getCurrentAttributeValue(); |
| | | ByteString getCurrentAttributeValue(); |
| | | |
| | | /** |
| | | * True if the first attribute of the resource entry is being evaluated. |
| | | * @return True if this is the first attribute. |
| | | */ |
| | | public boolean isFirstAttribute(); |
| | | boolean isFirstAttribute(); |
| | | |
| | | /** |
| | | * Set to true if the first attribute of the resource entry is |
| | |
| | | * @param isFirst True if this is the first attribute of the |
| | | * resource entry being evaluated. |
| | | */ |
| | | public void setIsFirstAttribute(boolean isFirst); |
| | | void setIsFirstAttribute(boolean isFirst); |
| | | |
| | | /** |
| | | * Set the attribute type to be evaluated. |
| | | * @param type The attribute type to set to. |
| | | */ |
| | | public void setCurrentAttributeType(AttributeType type); |
| | | void setCurrentAttributeType(AttributeType type); |
| | | |
| | | /** |
| | | * Set the attribute value to be evaluated. |
| | | * @param v The current attribute value to set to. |
| | | */ |
| | | public void setCurrentAttributeValue(ByteString v); |
| | | void setCurrentAttributeValue(ByteString v); |
| | | |
| | | /** |
| | | * True if the target matching code found an entry test rule. An |
| | | * entry test rule is an ACI without a targetattr target rule. |
| | | * @param val True if an entry test rule was found. |
| | | */ |
| | | public void setEntryTestRule(boolean val); |
| | | void setEntryTestRule(boolean val); |
| | | |
| | | /** |
| | | * True if an entry test rule was found. |
| | | * @return True if an entry test rule was found. |
| | | */ |
| | | public boolean hasEntryTestRule(); |
| | | boolean hasEntryTestRule(); |
| | | |
| | | /** |
| | | * Return the rights for this container's LDAP operation. |
| | | * @return The rights for the container's LDAP operation. |
| | | */ |
| | | public int getRights(); |
| | | int getRights(); |
| | | |
| | | /** |
| | | * Return the OID (Object Identifier) string of the control being evaluated. |
| | | * |
| | | * @return The OID string of the control being evaluated. |
| | | */ |
| | | public String getControlOID(); |
| | | String getControlOID(); |
| | | |
| | | |
| | | /** |
| | |
| | | * |
| | | * @return The OID string of the extended operation being evaluated. |
| | | */ |
| | | public String getExtOpOID(); |
| | | String getExtOpOID(); |
| | | |
| | | /** |
| | | * Checks if the container's rights has the specified rights. |
| | | * @param rights The rights to check for. |
| | | * @return True if the container's rights has the specified rights. |
| | | */ |
| | | public boolean hasRights(int rights); |
| | | boolean hasRights(int rights); |
| | | |
| | | /** |
| | | * Set the rights of the container to the specified rights. |
| | | * @param rights The rights to set the container's rights to. |
| | | */ |
| | | public void setRights(int rights); |
| | | void setRights(int rights); |
| | | |
| | | /** |
| | | * Set to true if the ACI had a targattrfilter rule that matched. |
| | | * @param v The value to use. |
| | | */ |
| | | public void setTargAttrFiltersMatch(boolean v); |
| | | void setTargAttrFiltersMatch(boolean v); |
| | | |
| | | /** |
| | | * Return the value of the targAttrFiltersMatch variable. This is set to |
| | | * true if the ACI had a targattrfilter rule that matched. |
| | | * @return True if the ACI had a targattrfilter rule that matched. |
| | | */ |
| | | public boolean getTargAttrFiltersMatch(); |
| | | boolean getTargAttrFiltersMatch(); |
| | | |
| | | /** |
| | | * Add the specified ACI to a list of ACIs that have a targattrfilters rule |
| | |
| | | * of an attribute that possibly might evaluate to true. |
| | | * @param aci The ACI to save. |
| | | */ |
| | | public void addTargAttrFiltersMatchAci(Aci aci); |
| | | void addTargAttrFiltersMatchAci(Aci aci); |
| | | |
| | | /** |
| | | * Save the name of the last ACI that matched a targattrfilters rule. This |
| | |
| | | /** |
| | | * Return true if the evaluating ACI either contained an explicitly defined |
| | | * user attribute type in a targeattr target rule or both a targetattr all |
| | | * user attributes rule matched and a explictly defined targetattr target rule |
| | | * user attributes rule matched and a explicitly defined targetattr target rule |
| | | * matched. |
| | | * |
| | | * @return True if the above condition was seen. |
| | |
| | | |
| | | /** |
| | | * Return true if the evaluating ACI either contained an explicitly defined |
| | | * operational attribute type in a targeattr target rule or both a targetattr |
| | | * all operational attributes rule matched and a explictly defined targetattr |
| | | * operational attribute type in a targetattr target rule or both a targetattr |
| | | * all operational attributes rule matched and a explicitly defined targetattr |
| | | * target rule matched. |
| | | * |
| | | * @return True if the above condition was seen. |
| | |
| | | * |
| | | * @param v The flag to clear or 0 to set the mask to 0. |
| | | */ |
| | | public void clearEvalAttributes(int v); |
| | | void clearEvalAttributes(int v); |
| | | } |
| | | |
| | | |
| | |
| | | * |
| | | * |
| | | * Copyright 2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2013 ForgeRock AS |
| | | * Portions Copyright 2013-2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.authorization.dseecompat; |
| | | |
| | |
| | | * @param evalCtx An evaluation context to use in the evaluation. |
| | | * @return An enumeration evaluation result. |
| | | */ |
| | | public EnumEvalResult evaluate(AciEvalContext evalCtx); |
| | | EnumEvalResult evaluate(AciEvalContext evalCtx); |
| | | |
| | | /** |
| | | * Appends a string representation of this object to the provided buffer. |
| | |
| | | * valid attribute value pattern from the |
| | | * provided DN string. |
| | | */ |
| | | static private int parseValuePattern(String dnString, int pos, |
| | | private static int parseValuePattern(String dnString, int pos, |
| | | ArrayList<ByteString> attributeValues) |
| | | throws DirectoryException |
| | | { |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2014 ForgeRock AS |
| | | * Portions Copyright 2014-2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.backends.jeb; |
| | | |
| | |
| | | * @param database A handle to the database. |
| | | * @return 1 for id2entry database, 2 for dn2id database, 3 for all others. |
| | | */ |
| | | static private int priority(DatabaseContainer database) |
| | | private static int priority(DatabaseContainer database) |
| | | { |
| | | String name = database.getName(); |
| | | if (name.endsWith(EntryContainer.ID2ENTRY_DATABASE_NAME)) |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2014 ForgeRock AS |
| | | * Portions Copyright 2014-2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.backends.pluggable; |
| | | |
| | |
| | | * @param database A handle to the database. |
| | | * @return 1 for id2entry database, 2 for dn2id database, 3 for all others. |
| | | */ |
| | | static private int priority(DatabaseContainer database) |
| | | private static int priority(DatabaseContainer database) |
| | | { |
| | | String indexName = database.getName().getIndexId(); |
| | | if (indexName.endsWith(SuffixContainer.ID2ENTRY_INDEX_NAME)) |
| | |
| | | |
| | | /** {@inheritDoc} */ |
| | | @Override |
| | | public void close(); |
| | | void close(); |
| | | } |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2009 Sun Microsystems, Inc. |
| | | * Portions Copyright 2014 ForgeRock AS |
| | | * Portions Copyright 2014-2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.controls; |
| | | import org.forgerock.i18n.LocalizableMessage; |
| | |
| | | /** |
| | | * ControlDecoder implementation to decode this control from a ByteString. |
| | | */ |
| | | private final static class Decoder |
| | | private static final class Decoder |
| | | implements ControlDecoder<AccountUsableResponseControl> |
| | | { |
| | | /** |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2014 ForgeRock AS |
| | | * Portions Copyright 2014-2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.controls; |
| | | import org.forgerock.i18n.LocalizableMessage; |
| | |
| | | /** |
| | | * ControlDecoder implementation to decode this control from a ByteString. |
| | | */ |
| | | private final static class Decoder |
| | | private static final class Decoder |
| | | implements ControlDecoder<AuthorizationIdentityResponseControl> |
| | | { |
| | | /** |
| | |
| | | /** |
| | | * ControlDecoder implementation to decode this control from a ByteString. |
| | | */ |
| | | private final static class Decoder |
| | | private static final class Decoder |
| | | implements ControlDecoder<EntryChangeNotificationControl> |
| | | { |
| | | /** |
| | |
| | | /** |
| | | * ControlDecoder implementation to decode this control from a ByteString. |
| | | */ |
| | | private final static class Decoder |
| | | private static final class Decoder |
| | | implements ControlDecoder<EntryChangelogNotificationControl> |
| | | { |
| | | /** |
| | |
| | | * |
| | | * |
| | | * Copyright 2009 Sun Microsystems, Inc. |
| | | * Portions Copyright 2011-2014 ForgeRock AS |
| | | * Portions Copyright 2011-2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.controls; |
| | | |
| | |
| | | /** |
| | | * ControlDecoder implementation to decode this control from a ByteString. |
| | | */ |
| | | private final static class Decoder |
| | | private static final class Decoder |
| | | implements ControlDecoder<ExternalChangelogRequestControl> |
| | | { |
| | | /** |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2014 ForgeRock AS |
| | | * Portions Copyright 2014-2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.controls; |
| | | import org.forgerock.i18n.LocalizableMessage; |
| | |
| | | /** |
| | | * ControlDecoder implementation to decode this control from a ByteString. |
| | | */ |
| | | private final static class Decoder |
| | | private static final class Decoder |
| | | implements ControlDecoder<LDAPAssertionRequestControl> |
| | | { |
| | | /** |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2013-2014 ForgeRock AS. |
| | | * Portions Copyright 2013-2015 ForgeRock AS. |
| | | */ |
| | | package org.opends.server.controls; |
| | | |
| | |
| | | /** |
| | | * ControlDecoder implementation to decode this control from a ByteString. |
| | | */ |
| | | private final static class Decoder implements |
| | | private static final class Decoder implements |
| | | ControlDecoder<LDAPPostReadRequestControl> |
| | | { |
| | | /** |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2014 ForgeRock AS |
| | | * Portions Copyright 2014-2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.controls; |
| | | import org.forgerock.i18n.LocalizableMessage; |
| | |
| | | /** |
| | | * ControlDecoder implementation to decode this control from a ByteString. |
| | | */ |
| | | private final static class Decoder |
| | | private static final class Decoder |
| | | implements ControlDecoder<LDAPPostReadResponseControl> |
| | | { |
| | | /** |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2013-2014 ForgeRock AS. |
| | | * Portions Copyright 2013-2015 ForgeRock AS. |
| | | */ |
| | | package org.opends.server.controls; |
| | | |
| | |
| | | /** |
| | | * ControlDecoder implementation to decode this control from a ByteString. |
| | | */ |
| | | private final static class Decoder implements |
| | | private static final class Decoder implements |
| | | ControlDecoder<LDAPPreReadRequestControl> |
| | | { |
| | | /** |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2014 ForgeRock AS |
| | | * Portions Copyright 2014-2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.controls; |
| | | import org.forgerock.i18n.LocalizableMessage; |
| | |
| | | /** |
| | | * ControlDecoder implementation to decode this control from a ByteString. |
| | | */ |
| | | private final static class Decoder |
| | | private static final class Decoder |
| | | implements ControlDecoder<LDAPPreReadResponseControl> |
| | | { |
| | | /** |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2014 ForgeRock AS |
| | | * Portions Copyright 2014-2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.controls; |
| | | import org.forgerock.i18n.LocalizableMessage; |
| | |
| | | /** |
| | | * ControlDecoder implementation to decode this control from a ByteString. |
| | | */ |
| | | private final static class Decoder |
| | | private static final class Decoder |
| | | implements ControlDecoder<MatchedValuesControl> |
| | | { |
| | | /** |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2014 ForgeRock AS |
| | | * Portions Copyright 2014-2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.controls; |
| | | |
| | |
| | | /** |
| | | * ControlDecoder implementation to decode this control from a ByteString. |
| | | */ |
| | | private final static class Decoder |
| | | private static final class Decoder |
| | | implements ControlDecoder<PagedResultsControl> |
| | | { |
| | | /** |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2014 ForgeRock AS |
| | | * Portions Copyright 2014-2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.controls; |
| | | import org.forgerock.i18n.LocalizableMessage; |
| | |
| | | /** |
| | | * ControlDecoder implementation to decode this control from a ByteString. |
| | | */ |
| | | private final static class Decoder |
| | | private static final class Decoder |
| | | implements ControlDecoder<PasswordExpiredControl> |
| | | { |
| | | /** |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2014 ForgeRock AS |
| | | * Portions Copyright 2014-2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.controls; |
| | | import org.forgerock.i18n.LocalizableMessage; |
| | |
| | | /** |
| | | * ControlDecoder implementation to decode this control from a ByteString. |
| | | */ |
| | | private final static class Decoder |
| | | private static final class Decoder |
| | | implements ControlDecoder<PasswordExpiringControl> |
| | | { |
| | | /** |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2014 ForgeRock AS |
| | | * Portions Copyright 2014-2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.controls; |
| | | import org.forgerock.i18n.LocalizableMessage; |
| | |
| | | /** |
| | | * ControlDecoder implementation to decode this control from a ByteString. |
| | | */ |
| | | private final static class Decoder |
| | | private static final class Decoder |
| | | implements ControlDecoder<PasswordPolicyRequestControl> |
| | | { |
| | | /** |
| | |
| | | /** |
| | | * ControlDecoder implementation to decode this control from a ByteString. |
| | | */ |
| | | private final static class Decoder |
| | | private static final class Decoder |
| | | implements ControlDecoder<PasswordPolicyResponseControl> |
| | | { |
| | | /** |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2014 ForgeRock AS |
| | | * Portions Copyright 2014-2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.controls; |
| | | import org.forgerock.i18n.LocalizableMessage; |
| | |
| | | /** |
| | | * ControlDecoder implementation to decode this control from a ByteString. |
| | | */ |
| | | private final static class Decoder |
| | | private static final class Decoder |
| | | implements ControlDecoder<PersistentSearchControl> |
| | | { |
| | | /** |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2011-2014 ForgeRock AS. |
| | | * Portions Copyright 2011-2015 ForgeRock AS. |
| | | */ |
| | | package org.opends.server.controls; |
| | | |
| | |
| | | /** |
| | | * ControlDecoder implementation to decode this control from a ByteString. |
| | | */ |
| | | private final static class Decoder |
| | | private static final class Decoder |
| | | implements ControlDecoder<ProxiedAuthV1Control> |
| | | { |
| | | /** |
| | |
| | | /** |
| | | * ControlDecoder implementation to decode this control from a ByteString. |
| | | */ |
| | | private final static class Decoder |
| | | private static final class Decoder |
| | | implements ControlDecoder<ServerSideSortRequestControl> |
| | | { |
| | | /** |
| | |
| | | * |
| | | * |
| | | * Copyright 2008-2009 Sun Microsystems, Inc. |
| | | * Portions Copyright 2014 ForgeRock AS |
| | | * Portions Copyright 2014-2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.controls; |
| | | import org.forgerock.i18n.LocalizableMessage; |
| | |
| | | /** |
| | | * ControlDecoder implementation to decode this control from a ByteString. |
| | | */ |
| | | private final static class Decoder |
| | | private static final class Decoder |
| | | implements ControlDecoder<ServerSideSortResponseControl> |
| | | { |
| | | /** |
| | |
| | | * |
| | | * |
| | | * Copyright 2009 Sun Microsystems, Inc. |
| | | * Portions Copyright 2014 ForgeRock AS |
| | | * Portions Copyright 2014-2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.controls; |
| | | |
| | |
| | | * ControlDecoder implementation to decode this control from a |
| | | * ByteString. |
| | | */ |
| | | private final static class Decoder implements |
| | | private static final class Decoder implements |
| | | ControlDecoder<SubtreeDeleteControl> |
| | | { |
| | | /** |
| | |
| | | * |
| | | * |
| | | * Copyright 2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2014 ForgeRock AS |
| | | * Portions Copyright 2014-2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.controls; |
| | | import org.forgerock.i18n.LocalizableMessage; |
| | |
| | | /** |
| | | * ControlDecoder implementation to decode this control from a ByteString. |
| | | */ |
| | | private final static class Decoder |
| | | private static final class Decoder |
| | | implements ControlDecoder<VLVRequestControl> |
| | | { |
| | | /** |
| | |
| | | /** |
| | | * ControlDecoder implementation to decode this control from a ByteString. |
| | | */ |
| | | private final static class Decoder |
| | | private static final class Decoder |
| | | implements ControlDecoder<VLVResponseControl> |
| | | { |
| | | /** |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.core; |
| | | |
| | |
| | | * |
| | | * @return The message ID of the operation that should be abandoned. |
| | | */ |
| | | public int getIDToAbandon(); |
| | | int getIDToAbandon(); |
| | | |
| | | } |
| | | |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2014 ForgeRock AS |
| | | * Portions Copyright 2014-2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.core; |
| | | import org.forgerock.i18n.LocalizableMessage; |
| | |
| | | * |
| | | * @return The authentication type for this bind operation. |
| | | */ |
| | | public abstract AuthenticationType getAuthenticationType(); |
| | | AuthenticationType getAuthenticationType(); |
| | | |
| | | /** |
| | | * Retrieves the raw, unprocessed bind DN for this bind operation as contained |
| | |
| | | * @return The raw, unprocessed bind DN for this bind operation as contained |
| | | * in the client request. |
| | | */ |
| | | public abstract ByteString getRawBindDN(); |
| | | ByteString getRawBindDN(); |
| | | |
| | | /** |
| | | * Specifies the raw, unprocessed bind DN for this bind operation. This |
| | |
| | | * |
| | | * @param rawBindDN The raw, unprocessed bind DN for this bind operation. |
| | | */ |
| | | public abstract void setRawBindDN(ByteString rawBindDN); |
| | | void setRawBindDN(ByteString rawBindDN); |
| | | |
| | | /** |
| | | * Retrieves a string representation of the protocol version associated with |
| | |
| | | * @return A string representation of the protocol version associated with |
| | | * this bind request. |
| | | */ |
| | | public String getProtocolVersion(); |
| | | String getProtocolVersion(); |
| | | |
| | | /** |
| | | * Specifies the string representation of the protocol version associated with |
| | |
| | | * @param protocolVersion The string representation of the protocol version |
| | | * associated with this bind request. |
| | | */ |
| | | public void setProtocolVersion(String protocolVersion); |
| | | void setProtocolVersion(String protocolVersion); |
| | | |
| | | /** |
| | | * Retrieves the bind DN for this bind operation. This method should not be |
| | |
| | | * @return The bind DN for this bind operation, or <CODE>null</CODE> if the |
| | | * raw DN has not yet been processed. |
| | | */ |
| | | public abstract DN getBindDN(); |
| | | DN getBindDN(); |
| | | |
| | | /** |
| | | * Retrieves the simple authentication password for this bind operation. |
| | | * |
| | | * @return The simple authentication password for this bind operation. |
| | | */ |
| | | public abstract ByteString getSimplePassword(); |
| | | ByteString getSimplePassword(); |
| | | |
| | | /** |
| | | * Specifies the simple authentication password for this bind operation. |
| | |
| | | * @param simplePassword The simple authentication password for this bind |
| | | * operation. |
| | | */ |
| | | public abstract void setSimplePassword(ByteString simplePassword); |
| | | void setSimplePassword(ByteString simplePassword); |
| | | |
| | | /** |
| | | * Retrieves the SASL mechanism for this bind operation. |
| | |
| | | * @return The SASL mechanism for this bind operation, or <CODE>null</CODE> |
| | | * if the bind does not use SASL authentication. |
| | | */ |
| | | public abstract String getSASLMechanism(); |
| | | String getSASLMechanism(); |
| | | |
| | | /** |
| | | * Retrieves the SASL credentials for this bind operation. |
| | |
| | | * @return The SASL credentials for this bind operation, or <CODE>null</CODE> |
| | | * if there are none or if the bind does not use SASL authentication. |
| | | */ |
| | | public abstract ByteString getSASLCredentials(); |
| | | ByteString getSASLCredentials(); |
| | | |
| | | /** |
| | | * Specifies the SASL credentials for this bind operation. |
| | |
| | | * @param saslCredentials The SASL credentials for this bind operation, or |
| | | * <CODE>null</CODE> if there are none. |
| | | */ |
| | | public abstract void setSASLCredentials(String saslMechanism, |
| | | ByteString saslCredentials); |
| | | void setSASLCredentials(String saslMechanism, ByteString saslCredentials); |
| | | |
| | | /** |
| | | * Retrieves the set of server SASL credentials to include in the bind |
| | |
| | | * @return The set of server SASL credentials to include in the bind |
| | | * response, or <CODE>null</CODE> if there are none. |
| | | */ |
| | | public abstract ByteString getServerSASLCredentials(); |
| | | ByteString getServerSASLCredentials(); |
| | | |
| | | /** |
| | | * Specifies the set of server SASL credentials to include in the bind |
| | |
| | | * @param serverSASLCredentials The set of server SASL credentials to |
| | | * include in the bind response. |
| | | */ |
| | | public abstract void setServerSASLCredentials( |
| | | ByteString serverSASLCredentials); |
| | | void setServerSASLCredentials(ByteString serverSASLCredentials); |
| | | |
| | | /** |
| | | * Retrieves the user entry associated with the SASL authentication attempt. |
| | |
| | | * <CODE>null</CODE> if it was not a SASL authentication or the SASL |
| | | * processing was not able to map the request to a user. |
| | | */ |
| | | public abstract Entry getSASLAuthUserEntry(); |
| | | Entry getSASLAuthUserEntry(); |
| | | |
| | | /** |
| | | * Specifies the user entry associated with the SASL authentication attempt. |
| | |
| | | * @param saslAuthUserEntry The user entry associated with the SASL |
| | | * authentication attempt. |
| | | */ |
| | | public abstract void setSASLAuthUserEntry(Entry saslAuthUserEntry); |
| | | void setSASLAuthUserEntry(Entry saslAuthUserEntry); |
| | | |
| | | /** |
| | | * Retrieves a human-readable message providing the reason that the |
| | |
| | | * @return A human-readable message providing the reason that the |
| | | * authentication failed, or <CODE>null</CODE> if none is available. |
| | | */ |
| | | public abstract LocalizableMessage getAuthFailureReason(); |
| | | LocalizableMessage getAuthFailureReason(); |
| | | |
| | | /** |
| | | * Specifies the reason that the authentication failed. |
| | |
| | | * @param message providing the reason that the |
| | | * authentication failed. |
| | | */ |
| | | public abstract void setAuthFailureReason(LocalizableMessage message); |
| | | void setAuthFailureReason(LocalizableMessage message); |
| | | |
| | | /** |
| | | * Retrieves the user entry DN for this bind operation. It will only be |
| | |
| | | * the bind processing has not progressed far enough to identify the |
| | | * user or if the user DN could not be determined. |
| | | */ |
| | | public abstract DN getUserEntryDN(); |
| | | DN getUserEntryDN(); |
| | | |
| | | /** |
| | | * Retrieves the authentication info that resulted from processing this bind |
| | |
| | | * @return The authentication info that resulted from processing this bind |
| | | * operation. |
| | | */ |
| | | public abstract AuthenticationInfo getAuthenticationInfo(); |
| | | AuthenticationInfo getAuthenticationInfo(); |
| | | |
| | | /** |
| | | * Specifies the authentication info that resulted from processing this bind |
| | |
| | | * @param authInfo The authentication info that resulted from processing |
| | | * this bind operation. |
| | | */ |
| | | public abstract void setAuthenticationInfo(AuthenticationInfo authInfo); |
| | | void setAuthenticationInfo(AuthenticationInfo authInfo); |
| | | |
| | | /** |
| | | * Set the user entry DN for this bind operation. |
| | |
| | | * progressed far enough to identify the user or if |
| | | * the user DN could not be determined. |
| | | */ |
| | | public abstract void setUserEntryDN(DN userEntryDN); |
| | | void setUserEntryDN(DN userEntryDN); |
| | | |
| | | |
| | | } |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2009 Sun Microsystems, Inc. |
| | | * Portions Copyright 2014 ForgeRock AS |
| | | * Portions Copyright 2014-2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.core; |
| | | |
| | |
| | | * |
| | | * @return The raw, unprocessed entry DN as included in the client request. |
| | | */ |
| | | public ByteString getRawEntryDN(); |
| | | ByteString getRawEntryDN(); |
| | | |
| | | |
| | | /** |
| | |
| | | * @param rawEntryDN The raw, unprocessed entry DN as included in the client |
| | | * request. |
| | | */ |
| | | public void setRawEntryDN(ByteString rawEntryDN); |
| | | void setRawEntryDN(ByteString rawEntryDN); |
| | | |
| | | |
| | | /** |
| | |
| | | * @return The DN of the entry to compare, or <CODE>null</CODE> if the raw |
| | | * entry DN has not yet been processed. |
| | | */ |
| | | public DN getEntryDN(); |
| | | DN getEntryDN(); |
| | | |
| | | |
| | | /** |
| | |
| | | * |
| | | * @return The raw attribute type for this compare operation. |
| | | */ |
| | | public String getRawAttributeType(); |
| | | String getRawAttributeType(); |
| | | |
| | | |
| | | /** |
| | |
| | | * @param rawAttributeType The raw attribute type for this compare |
| | | * operation. |
| | | */ |
| | | public void setRawAttributeType(String rawAttributeType); |
| | | void setRawAttributeType(String rawAttributeType); |
| | | |
| | | |
| | | /** |
| | |
| | | * |
| | | * @return The attribute type for this compare operation. |
| | | */ |
| | | public AttributeType getAttributeType(); |
| | | AttributeType getAttributeType(); |
| | | |
| | | |
| | | /** |
| | |
| | | * |
| | | * @param attributeType The attribute type for this compare operation. |
| | | */ |
| | | public void setAttributeType(AttributeType attributeType); |
| | | void setAttributeType(AttributeType attributeType); |
| | | |
| | | |
| | | /** |
| | |
| | | * |
| | | * @return The attribute options for this compare operation. |
| | | */ |
| | | public Set<String> getAttributeOptions(); |
| | | Set<String> getAttributeOptions(); |
| | | |
| | | /** |
| | | * Specifies the attribute options for this compare operation. |
| | | * |
| | | * @param attributeOptions The attribute options for this compare operation. |
| | | */ |
| | | public void setAttributeOptions(Set<String> attributeOptions); |
| | | void setAttributeOptions(Set<String> attributeOptions); |
| | | |
| | | /** |
| | | * Retrieves the assertion value for this compare operation. |
| | | * |
| | | * @return The assertion value for this compare operation. |
| | | */ |
| | | public ByteString getAssertionValue(); |
| | | ByteString getAssertionValue(); |
| | | |
| | | |
| | | /** |
| | |
| | | * |
| | | * @param assertionValue The assertion value for this compare operation. |
| | | */ |
| | | public void setAssertionValue(ByteString assertionValue); |
| | | void setAssertionValue(ByteString assertionValue); |
| | | |
| | | |
| | | /** |
| | |
| | | * |
| | | * @return The proxied authorization target DN for this compare operation |
| | | */ |
| | | public DN getProxiedAuthorizationDN(); |
| | | DN getProxiedAuthorizationDN(); |
| | | |
| | | |
| | | /** |
| | |
| | | * @param proxiedAuthorizationDN The proxied authorization target DN for |
| | | * this compare operation |
| | | */ |
| | | public void setProxiedAuthorizationDN(DN proxiedAuthorizationDN); |
| | | void setProxiedAuthorizationDN(DN proxiedAuthorizationDN); |
| | | |
| | | } |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2009 Sun Microsystems, Inc. |
| | | * Portions Copyright 2014 ForgeRock AS |
| | | * Portions Copyright 2014-2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.core; |
| | | |
| | |
| | | * @return The OID for the request associated with this extended |
| | | * operation. |
| | | */ |
| | | public String getRequestOID(); |
| | | String getRequestOID(); |
| | | |
| | | |
| | | |
| | |
| | | * @return The value for the request associated with this extended |
| | | * operation. |
| | | */ |
| | | public ByteString getRequestValue(); |
| | | ByteString getRequestValue(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The OID to include in the response to the client. |
| | | */ |
| | | public String getResponseOID(); |
| | | String getResponseOID(); |
| | | |
| | | |
| | | |
| | |
| | | * @param responseOID The OID to include in the response to the |
| | | * client. |
| | | */ |
| | | public void setResponseOID(String responseOID); |
| | | void setResponseOID(String responseOID); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The value to include in the response to the client. |
| | | */ |
| | | public ByteString getResponseValue(); |
| | | ByteString getResponseValue(); |
| | | |
| | | |
| | | |
| | |
| | | * @param responseValue The value to include in the response to |
| | | * the client. |
| | | */ |
| | | public void setResponseValue(ByteString responseValue); |
| | | void setResponseValue(ByteString responseValue); |
| | | } |
| | | |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2011-2014 ForgeRock AS |
| | | * Portions Copyright 2011-2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.core; |
| | | |
| | |
| | | |
| | | /** {@inheritDoc} */ |
| | | @Override |
| | | public synchronized final void checkIfCanceled(boolean signalTooLate) |
| | | final synchronized public void checkIfCanceled(boolean signalTooLate) |
| | | throws CanceledOperationException { |
| | | operation.checkIfCanceled(signalTooLate); |
| | | } |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2013 ForgeRock AS |
| | | * Portions Copyright 2013-2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.core; |
| | | |
| | |
| | | * @throws org.opends.server.types.DirectoryException |
| | | * If a problem occurs in the Directory Server. |
| | | */ |
| | | public void enqueueRequest(Operation operation) throws DirectoryException; |
| | | void enqueueRequest(Operation operation) throws DirectoryException; |
| | | |
| | | } |
| | |
| | | * CDDL HEADER END |
| | | * |
| | | * |
| | | * Copyright 2014 ForgeRock AS. |
| | | * Copyright 2014-2015 ForgeRock AS. |
| | | */ |
| | | package org.opends.server.core; |
| | | |
| | |
| | | * |
| | | * @return the instance root directory |
| | | */ |
| | | public String getInstanceRoot(); |
| | | String getInstanceRoot(); |
| | | |
| | | /** |
| | | * Returns the root directory of server. |
| | | * |
| | | * @return the server root directory |
| | | */ |
| | | public String getServerRoot(); |
| | | String getServerRoot(); |
| | | |
| | | /** |
| | | * Returns the schema of the server. |
| | | * |
| | | * @return the schema |
| | | */ |
| | | public Schema getSchema(); |
| | | Schema getSchema(); |
| | | |
| | | /** |
| | | * Returns the schema updater, which provides |
| | |
| | | * |
| | | * @return the schema updater |
| | | */ |
| | | public SchemaUpdater getSchemaUpdater(); |
| | | SchemaUpdater getSchemaUpdater(); |
| | | |
| | | /** |
| | | * Returns the environment of the server. |
| | | * |
| | | * @return the environment |
| | | */ |
| | | public DirectoryEnvironmentConfig getEnvironment(); |
| | | DirectoryEnvironmentConfig getEnvironment(); |
| | | |
| | | /** |
| | | * Returns the server management context, which gives |
| | |
| | | * |
| | | * @return the server management context |
| | | */ |
| | | public ServerManagementContext getServerManagementContext(); |
| | | ServerManagementContext getServerManagementContext(); |
| | | |
| | | } |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2009 Sun Microsystems, Inc. |
| | | * Portions Copyright 2013-2014 ForgeRock AS |
| | | * Portions Copyright 2013-2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.extensions; |
| | | |
| | | import org.forgerock.i18n.LocalizableMessageBuilder; |
| | | |
| | | |
| | | |
| | | /** |
| | | * This interface defines a set of methods that must be implemented by a class |
| | | * (expected to be a client connection) that can dynamically enable and disable |
| | |
| | | * @return <CODE>true</CODE> if TLS is available on the underlying client |
| | | * connection, or <CODE>false</CODE> if it is not. |
| | | */ |
| | | public boolean prepareTLS(LocalizableMessageBuilder unavailableReason); |
| | | boolean prepareTLS(LocalizableMessageBuilder unavailableReason); |
| | | } |
| | | |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2014 ForgeRock AS. |
| | | * Portions Copyright 2014-2015 ForgeRock AS. |
| | | */ |
| | | package org.opends.server.loggers; |
| | | |
| | |
| | | * the frames to filter |
| | | * @return an array of StackTraceElements to be used in formatting. |
| | | */ |
| | | public StackTraceElement[] getFilteredStackTrace(StackTraceElement[] frames); |
| | | StackTraceElement[] getFilteredStackTrace(StackTraceElement[] frames); |
| | | } |
| | | |
| | | /** |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2009 Sun Microsystems, Inc. |
| | | * Portions Copyright 2014 ForgeRock AS |
| | | * Portions Copyright 2014-2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.loggers; |
| | | |
| | |
| | | * |
| | | * @return the initial file. |
| | | */ |
| | | public File getInitialName(); |
| | | File getInitialName(); |
| | | |
| | | /** |
| | | * Gets the next name to use. |
| | | * |
| | | * @return the next file. |
| | | */ |
| | | public File getNextName(); |
| | | File getNextName(); |
| | | |
| | | /** |
| | | * Gets the filename filter that can be used to filter files named by this |
| | |
| | | * |
| | | * @return The FilenameFilter that can filter files named by this policy. |
| | | */ |
| | | public FilenameFilter getFilenameFilter(); |
| | | FilenameFilter getFilenameFilter(); |
| | | |
| | | /** |
| | | * Gets all the existing files named by this policy in the parent directoy |
| | | * Gets all the existing files named by this policy in the parent directory |
| | | * of the initial file. The initial file is excluded from this list if it |
| | | * exists. |
| | | * |
| | | * @return The files named by this policy or <code>null</code> if an |
| | | * error occured. |
| | | * error occurred. |
| | | */ |
| | | public File[] listFiles(); |
| | | File[] listFiles(); |
| | | |
| | | |
| | | } |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2014 ForgeRock AS |
| | | * Portions Copyright 2014-2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.loggers; |
| | | |
| | |
| | | /** |
| | | * Flush the underlying stream. |
| | | */ |
| | | |
| | | public void flush(); |
| | | void flush(); |
| | | |
| | | /** |
| | | * Action to take when the logger thread generates an alarm based |
| | | * on the rotation policy condition being met. |
| | | * |
| | | */ |
| | | public void rollover(); |
| | | void rollover(); |
| | | |
| | | |
| | | /** |
| | |
| | | * |
| | | * @param actions An array of actions that need to be executed on rotation. |
| | | */ |
| | | public void setPostRotationActions(ArrayList<ActionType> actions); |
| | | |
| | | void setPostRotationActions(ArrayList<ActionType> actions); |
| | | |
| | | } |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2014 ForgeRock AS |
| | | * Portions Copyright 2014-2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.loggers; |
| | | |
| | | |
| | | |
| | | /** |
| | | * This interface describes the action that needs to be taken |
| | | * at the time of a rotation. |
| | |
| | | * @return <CODE>true</CODE> if the rotation action was successful, or |
| | | * <CODE>false</CODE> if it was not. |
| | | */ |
| | | public boolean execute(); |
| | | boolean execute(); |
| | | |
| | | } |
| | | |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2013-2014 ForgeRock AS |
| | | * Portions Copyright 2013-2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.loggers; |
| | | |
| | |
| | | * If a problem occurs during initialization that is not |
| | | * related to the server configuration. |
| | | */ |
| | | public abstract void initializeLogRetentionPolicy(T config) |
| | | void initializeLogRetentionPolicy(T config) |
| | | throws ConfigException, InitializationException; |
| | | |
| | | /** |
| | |
| | | * names. |
| | | * |
| | | * @return An array of files that should be deleted according to the |
| | | * policy or <code>null</code> if an error occured while |
| | | * policy or <code>null</code> if an error occurred while |
| | | * obtaining the file list. |
| | | * @throws DirectoryException If an error occurs while obtaining a list |
| | | * of files to delete. |
| | | */ |
| | | public File[] deleteFiles(FileNamingPolicy fileNamingPolicy) |
| | | File[] deleteFiles(FileNamingPolicy fileNamingPolicy) |
| | | throws DirectoryException; |
| | | } |
| | | |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2014 ForgeRock AS |
| | | * Portions Copyright 2014-2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.loggers; |
| | | |
| | |
| | | * If a problem occurs during initialization that is not |
| | | * related to the server configuration. |
| | | */ |
| | | public abstract void initializeLogRotationPolicy(T config) |
| | | void initializeLogRotationPolicy(T config) |
| | | throws ConfigException, InitializationException; |
| | | |
| | | |
| | |
| | | * the file writer to be checked. |
| | | * @return true if the log file should be rotated, false otherwise. |
| | | */ |
| | | public boolean rotateFile(RotatableLogFile writer); |
| | | boolean rotateFile(RotatableLogFile writer); |
| | | |
| | | |
| | | } |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.loggers; |
| | | |
| | |
| | | * |
| | | * @param record - the record to write. |
| | | */ |
| | | public void writeRecord(String record); |
| | | void writeRecord(String record); |
| | | |
| | | /** |
| | | * Flushes any buffered contents of the output stream. |
| | | */ |
| | | public void flush(); |
| | | void flush(); |
| | | |
| | | /** |
| | | * Releases any resources held by the writer. |
| | | */ |
| | | public void shutdown(); |
| | | void shutdown(); |
| | | |
| | | /** |
| | | * Retrieves the number of bytes written by this writer. |
| | | * |
| | | * @return the number of bytes written by this writer. |
| | | */ |
| | | public long getBytesWritten(); |
| | | long getBytesWritten(); |
| | | |
| | | /** |
| | | * A TextWriter implementationwhich writes to standard out. |
| | | * A TextWriter implementation which writes to standard out. |
| | | */ |
| | | public static class STDOUT implements TextWriter |
| | | { |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.protocols.internal; |
| | | |
| | |
| | | * the search operation will result |
| | | * will be set based on this exception. |
| | | */ |
| | | public void handleInternalSearchEntry( |
| | | void handleInternalSearchEntry( |
| | | InternalSearchOperation searchOperation, |
| | | SearchResultEntry searchEntry) |
| | | throws DirectoryException; |
| | |
| | | * the search operation will result |
| | | * will be set based on this exception. |
| | | */ |
| | | public void handleInternalSearchReference( |
| | | void handleInternalSearchReference( |
| | | InternalSearchOperation searchOperation, |
| | | SearchResultReference searchReference) |
| | | throws DirectoryException; |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2008 Sun Microsystems, Inc. |
| | | * Portions copyright 2013 ForgeRock AS |
| | | * Portions Copyright 2013-2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.replication.plugin; |
| | | |
| | |
| | | * @return A ReplicationMsg that can be used to send information |
| | | * about this operation to remote servers. |
| | | */ |
| | | abstract public ReplicationMsg generateMessage(); |
| | | public abstract ReplicationMsg generateMessage(); |
| | | } |
| | |
| | | * |
| | | * |
| | | * Copyright 2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2013-2014 ForgeRock AS. |
| | | * Portions Copyright 2013-2015 ForgeRock AS. |
| | | */ |
| | | package org.opends.server.replication.plugin; |
| | | |
| | |
| | | /** |
| | | * ControlDecoder implementation to decode this control from a ByteString. |
| | | */ |
| | | private final static class Decoder |
| | | private static final class Decoder |
| | | implements ControlDecoder<ReplicationRepairRequestControl> |
| | | { |
| | | /** |
| | |
| | | * CDDL HEADER END |
| | | * |
| | | * |
| | | * Copyright 2013-2014 ForgeRock AS |
| | | * Copyright 2013-2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.replication.server.changelog.api; |
| | | |
| | |
| | | * If a database problem happened |
| | | * @see #getCursorFrom(DN, ServerState, KeyMatchingStrategy, PositionStrategy) |
| | | */ |
| | | public MultiDomainDBCursor getCursorFrom(MultiDomainServerState startState, KeyMatchingStrategy matchingStrategy, |
| | | MultiDomainDBCursor getCursorFrom(MultiDomainServerState startState, KeyMatchingStrategy matchingStrategy, |
| | | PositionStrategy positionStrategy) throws ChangelogException; |
| | | |
| | | /** |
| | |
| | | * If a database problem happened |
| | | * @see #getCursorFrom(DN, ServerState, KeyMatchingStrategy, PositionStrategy) |
| | | */ |
| | | public MultiDomainDBCursor getCursorFrom(MultiDomainServerState startState, KeyMatchingStrategy matchingStrategy, |
| | | MultiDomainDBCursor getCursorFrom(MultiDomainServerState startState, KeyMatchingStrategy matchingStrategy, |
| | | PositionStrategy positionStrategy, Set<DN> excludedDomainDns) throws ChangelogException; |
| | | |
| | | /** |
| | |
| | | * Contains all the attributes included for the ECL (External Changelog). |
| | | */ |
| | | // @Immutable |
| | | private final static class ECLIncludes |
| | | private static final class ECLIncludes |
| | | { |
| | | |
| | | final Map<Integer, Set<String>> includedAttrsByServer; |
| | |
| | | /** |
| | | * Stores mapping between configuration attribute name and its label. |
| | | */ |
| | | static private Map<String,LocalizableMessage> argDisplayMap = |
| | | private static Map<String,LocalizableMessage> argDisplayMap = |
| | | new HashMap<String,LocalizableMessage>(); |
| | | static { |
| | | argDisplayMap.put( |
| | |
| | | /** |
| | | * Stores mapping between configuration attribute name and its label. |
| | | */ |
| | | static private Map<String,LocalizableMessage> argDisplayMap = |
| | | private static Map<String,LocalizableMessage> argDisplayMap = |
| | | new HashMap<String,LocalizableMessage>(); |
| | | static { |
| | | argDisplayMap.put( |
| | |
| | | /** |
| | | * Stores mapping between configuration attribute name and its label. |
| | | */ |
| | | static private Map<String,LocalizableMessage> argDisplayMap = |
| | | private static Map<String,LocalizableMessage> argDisplayMap = |
| | | new HashMap<String,LocalizableMessage>(); |
| | | static { |
| | | argDisplayMap.put( |
| | |
| | | } |
| | | } |
| | | |
| | | final private static String DEFAULT_JAVA_HOME_PROP_NAME = "default.java-home"; |
| | | final private static String DEFAULT_JAVA_ARGS_PROP_NAME = "default.java-args"; |
| | | final private static String OVERWRITE_ENV_JAVA_HOME_PROP_NAME = |
| | | private static final String DEFAULT_JAVA_HOME_PROP_NAME = "default.java-home"; |
| | | private static final String DEFAULT_JAVA_ARGS_PROP_NAME = "default.java-args"; |
| | | private static final String OVERWRITE_ENV_JAVA_HOME_PROP_NAME = |
| | | "overwrite-env-java-home"; |
| | | final private static String OVERWRITE_ENV_JAVA_ARGS_PROP_NAME = |
| | | private static final String OVERWRITE_ENV_JAVA_ARGS_PROP_NAME = |
| | | "overwrite-env-java-args"; |
| | | |
| | | /** |
| | |
| | | /** |
| | | * Base for callbacks that implement top level menu items. |
| | | */ |
| | | static abstract private class TopMenuCallback |
| | | private static abstract class TopMenuCallback |
| | | implements MenuCallback<Void> { |
| | | |
| | | /** |
| | |
| | | /** |
| | | * Base for callbacks that manage task entries. |
| | | */ |
| | | static abstract private class TaskOperationCallback |
| | | private static abstract class TaskOperationCallback |
| | | implements MenuCallback<TaskEntry> { |
| | | |
| | | /** ID of the task to manage. */ |
| | |
| | | /** |
| | | * Executable for printing a task summary table. |
| | | */ |
| | | static private class PrintSummaryTop extends TopMenuCallback { |
| | | private static class PrintSummaryTop extends TopMenuCallback { |
| | | |
| | | @Override |
| | | public MenuResult<Void> invoke(ManageTasks app) |
| | |
| | | } |
| | | |
| | | /** |
| | | * Exectutable for printing a particular task's details. |
| | | * Executable for printing a particular task's details. |
| | | */ |
| | | static private class TaskDrilldownMenu extends TopMenuCallback { |
| | | private static class TaskDrilldownMenu extends TopMenuCallback { |
| | | |
| | | private String taskId; |
| | | |
| | |
| | | } |
| | | |
| | | /** |
| | | * Exectutable for printing a particular task's details. |
| | | * Executable for printing a particular task's details. |
| | | */ |
| | | static private class PrintTaskInfo extends TaskOperationCallback { |
| | | private static class PrintTaskInfo extends TaskOperationCallback { |
| | | |
| | | /** |
| | | * Constructs a parameterized instance. |
| | |
| | | /** |
| | | * Executable for printing a particular task's details. |
| | | */ |
| | | static private class ViewTaskLogs extends TaskOperationCallback { |
| | | private static class ViewTaskLogs extends TaskOperationCallback { |
| | | |
| | | /** |
| | | * Constructs a parameterized instance. |
| | |
| | | /** |
| | | * Executable for canceling a particular task. |
| | | */ |
| | | static private class CancelTaskTop extends TopMenuCallback { |
| | | private static class CancelTaskTop extends TopMenuCallback { |
| | | |
| | | private List<String> taskIds; |
| | | private List<Integer> cancelableIndices; |
| | |
| | | /** |
| | | * Executable for canceling a particular task. |
| | | */ |
| | | static private class CancelTask extends TaskOperationCallback { |
| | | private static class CancelTask extends TaskOperationCallback { |
| | | |
| | | /** |
| | | * Constructs a parameterized instance. |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2009 Sun Microsystems, Inc. |
| | | * Portions Copyright 2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.tools.makeldif; |
| | | |
| | |
| | | * |
| | | * @throws MakeLDIFException If some other problem occurs. |
| | | */ |
| | | public boolean writeEntry(TemplateEntry entry) |
| | | boolean writeEntry(TemplateEntry entry) |
| | | throws IOException, MakeLDIFException; |
| | | |
| | | |
| | |
| | | * Notifies the entry writer that no more entries will be provided and that |
| | | * any associated cleanup may be performed. |
| | | */ |
| | | public void closeEntryWriter(); |
| | | void closeEntryWriter(); |
| | | } |
| | | |
| | |
| | | * @param err stream to write messages; may be null |
| | | * @return int indicating the result of this action |
| | | */ |
| | | abstract protected int processLocal(boolean initializeServer, |
| | | protected abstract int processLocal(boolean initializeServer, |
| | | PrintStream out, |
| | | PrintStream err); |
| | | |
| | |
| | | * to act as the new file object |
| | | * @return FileOperation as the same type as this class |
| | | */ |
| | | abstract public FileOperation copyForChild(File child); |
| | | public abstract FileOperation copyForChild(File child); |
| | | |
| | | |
| | | |
| | |
| | | * @throws IOException |
| | | * if there is a problem. |
| | | */ |
| | | abstract public void apply() throws IOException; |
| | | public abstract void apply() throws IOException; |
| | | |
| | | } |
| | | |
| | |
| | | /** |
| | | * The File object related to the license file. |
| | | */ |
| | | static private File licFile; |
| | | private static File licFile; |
| | | |
| | | /** |
| | | * The license file approval state. |
| | | */ |
| | | static private boolean approved; |
| | | private static boolean approved; |
| | | |
| | | /** |
| | | * Returns the license file name. |
| | | */ |
| | | static private String getName() |
| | | private static String getName() |
| | | { |
| | | return getLegalDirectory() + File.separatorChar + "license_to_accept.txt"; |
| | | } |
| | |
| | | /** |
| | | * Returns the license file object. |
| | | */ |
| | | static private File getFile() |
| | | private static File getFile() |
| | | { |
| | | if (licFile == null) |
| | | { |
| | |
| | | */ |
| | | class UpgradeLog |
| | | { |
| | | static private File logFile; |
| | | static private FileHandler fileHandler; |
| | | final static String UPGRADELOGNAME = "upgrade.log"; |
| | | private static File logFile; |
| | | private static FileHandler fileHandler; |
| | | static final String UPGRADELOGNAME = "upgrade.log"; |
| | | |
| | | /** |
| | | * Creates a new file handler for writing log messages into |
| | |
| | | * CDDL HEADER END |
| | | * |
| | | * |
| | | * Portions Copyright 2013-2014 ForgeRock AS |
| | | * Portions Copyright 2013-2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.tools.upgrade; |
| | | |
| | |
| | | * |
| | | * @return A schema which may used in the upgrade context. |
| | | */ |
| | | final static Schema getUpgradeSchema() { |
| | | static Schema getUpgradeSchema() { |
| | | final SchemaBuilder sb = new SchemaBuilder(Schema.getCoreSchema()) |
| | | .setOption(DEFAULT_MATCHING_RULE_OID, getCaseExactMatchingRule().getOID()) |
| | | .setOption(DEFAULT_SYNTAX_OID, getDirectoryStringSyntax().getOID()); |
| | |
| | | * {@code null}, then any existing definition will be |
| | | * removed. |
| | | */ |
| | | public static final void setExtraProperty(SchemaFileElement elem, |
| | | public static void setExtraProperty(SchemaFileElement elem, |
| | | String name, String value) |
| | | { |
| | | ifNull(name); |
| | |
| | | * case that the Directory Server is in the process of an in-core |
| | | * restart because it will destroy the existing lock table. |
| | | */ |
| | | public synchronized static void reinitializeLockTable() |
| | | public static synchronized void reinitializeLockTable() |
| | | { |
| | | ConcurrentHashMap<DN,ReentrantReadWriteLock> oldTable = lockTable; |
| | | |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2014 ForgeRock AS |
| | | * Portions Copyright 2014-2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.types; |
| | | |
| | |
| | | * operation should continue, or <CODE>false</CODE> if it |
| | | * should stop. |
| | | */ |
| | | public boolean continueProcessing(); |
| | | boolean continueProcessing(); |
| | | |
| | | /** |
| | | * Retrieves the error message if <code>continueProcessing</code> |
| | |
| | | * @return An error message explaining why processing should |
| | | * stop or <code>null</code> if none is provided. |
| | | */ |
| | | public LocalizableMessage getErrorMessage(); |
| | | LocalizableMessage getErrorMessage(); |
| | | |
| | | /** |
| | | * Retrieves the result code for the operation |
| | |
| | | * @return the result code for the operation or <code>null</code> |
| | | * if none is provided. |
| | | */ |
| | | public ResultCode getResultCode(); |
| | | ResultCode getResultCode(); |
| | | |
| | | /** |
| | | * Retrieves the matched DN for the operation |
| | |
| | | * @return the matched DN for the operation or <code>null</code> |
| | | * if none is provided. |
| | | */ |
| | | public DN getMatchedDN(); |
| | | DN getMatchedDN(); |
| | | |
| | | /** |
| | | * Retrieves the referral URLs for the operation |
| | | * if <code>continueProcessing</code> returned <code>false</code>. |
| | | * |
| | | * @return the refferal URLs for the operation or |
| | | * @return the referral URLs for the operation or |
| | | * <code>null</code> if none is provided. |
| | | */ |
| | | public List<String> getReferralURLs(); |
| | | List<String> getReferralURLs(); |
| | | |
| | | /** |
| | | * Defines a continue processing synchronization provider result. |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2011-2014 ForgeRock AS. |
| | | * Portions Copyright 2011-2015 ForgeRock AS. |
| | | */ |
| | | package org.opends.server.types.operation; |
| | | import org.forgerock.i18n.LocalizableMessage; |
| | |
| | | * @param control The control to add to the set of controls to |
| | | * include in the response to the client. |
| | | */ |
| | | public void addResponseControl(Control control); |
| | | void addResponseControl(Control control); |
| | | |
| | | |
| | | |
| | |
| | | * @param control The control to remove from the set of controls |
| | | * to include in the response to the client. |
| | | */ |
| | | public void removeResponseControl(Control control); |
| | | void removeResponseControl(Control control); |
| | | |
| | | |
| | | |
| | |
| | | * <CODE>UNDEFINED</CODE> if the operation has not yet |
| | | * completed. |
| | | */ |
| | | public ResultCode getResultCode(); |
| | | ResultCode getResultCode(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @param resultCode The result code for this operation. |
| | | */ |
| | | public void setResultCode(ResultCode resultCode); |
| | | void setResultCode(ResultCode resultCode); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The error message for this operation. |
| | | */ |
| | | public LocalizableMessageBuilder getErrorMessage(); |
| | | LocalizableMessageBuilder getErrorMessage(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @param errorMessage The error message for this operation. |
| | | */ |
| | | public void setErrorMessage(LocalizableMessageBuilder errorMessage); |
| | | void setErrorMessage(LocalizableMessageBuilder errorMessage); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @param message The message to append to the error message |
| | | */ |
| | | public void appendErrorMessage(LocalizableMessage message); |
| | | void appendErrorMessage(LocalizableMessage message); |
| | | |
| | | |
| | | |
| | |
| | | * if the operation has not yet completed or does not have |
| | | * a matched DN. |
| | | */ |
| | | public DN getMatchedDN(); |
| | | DN getMatchedDN(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @param matchedDN The matched DN for this operation. |
| | | */ |
| | | public void setMatchedDN(DN matchedDN); |
| | | void setMatchedDN(DN matchedDN); |
| | | |
| | | |
| | | |
| | |
| | | * <CODE>null</CODE> if the operation is not yet complete |
| | | * or does not have a set of referral URLs. |
| | | */ |
| | | public List<String> getReferralURLs(); |
| | | List<String> getReferralURLs(); |
| | | |
| | | |
| | | |
| | |
| | | * @param referralURLs The set of referral URLs for this |
| | | * operation. |
| | | */ |
| | | public void setReferralURLs(List<String> referralURLs); |
| | | void setReferralURLs(List<String> referralURLs); |
| | | |
| | | |
| | | |
| | |
| | | * information to use for the response |
| | | * elements. |
| | | */ |
| | | public void setResponseData(DirectoryException directoryException); |
| | | void setResponseData(DirectoryException directoryException); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The authorization DN for this operation. |
| | | */ |
| | | public DN getAuthorizationDN(); |
| | | DN getAuthorizationDN(); |
| | | |
| | | |
| | | |
| | |
| | | * @return An unmodifiable list containing the additional log items for this |
| | | * operation. |
| | | */ |
| | | public List<AdditionalLogItem> getAdditionalLogItems(); |
| | | List<AdditionalLogItem> getAdditionalLogItems(); |
| | | |
| | | |
| | | |
| | |
| | | * @param item |
| | | * The additional log item for this operation. |
| | | */ |
| | | public void addAdditionalLogItem(AdditionalLogItem item); |
| | | void addAdditionalLogItem(AdditionalLogItem item); |
| | | } |
| | | |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.types.operation; |
| | | |
| | |
| | | * @return The message ID of the operation that should be |
| | | * abandoned. |
| | | */ |
| | | public int getIDToAbandon(); |
| | | int getIDToAbandon(); |
| | | } |
| | | |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2014 ForgeRock AS |
| | | * Portions Copyright 2014-2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.types.operation; |
| | | |
| | |
| | | * |
| | | * @return The DN of the entry in a raw, unparsed form. |
| | | */ |
| | | public ByteString getRawEntryDN(); |
| | | ByteString getRawEntryDN(); |
| | | |
| | | |
| | | |
| | |
| | | * @return The set of attributes in their raw, unparsed form as |
| | | * read from the client request. |
| | | */ |
| | | public List<RawAttribute> getRawAttributes(); |
| | | List<RawAttribute> getRawAttributes(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The DN of the entry to add. |
| | | */ |
| | | public DN getEntryDN(); |
| | | DN getEntryDN(); |
| | | |
| | | |
| | | |
| | | /** |
| | | * Retrieves the set of processed objectclasses for the entry to |
| | | * add. The contents of the returned map must not be altered by the |
| | | * caller. |
| | | * add. The contents of the returned map must not be altered by the caller. |
| | | * |
| | | * @return The set of processed objectclasses for the entry to add. |
| | | */ |
| | | public Map<ObjectClass,String> getObjectClasses(); |
| | | Map<ObjectClass,String> getObjectClasses(); |
| | | |
| | | |
| | | |
| | | /** |
| | | * Retrieves the set of processed user attributes for the entry to |
| | | * add. The contents of the returned map must not be altered by the |
| | | * caller. |
| | | * add. The contents of the returned map must not be altered by the caller. |
| | | * |
| | | * @return The set of processed user attributes for the entry to |
| | | * add. |
| | | * @return The set of processed user attributes for the entry to add. |
| | | */ |
| | | public Map<AttributeType,List<Attribute>> getUserAttributes(); |
| | | Map<AttributeType,List<Attribute>> getUserAttributes(); |
| | | |
| | | |
| | | |
| | |
| | | * entry to add. The contents of the returned map must not be |
| | | * altered by the caller. |
| | | * |
| | | * @return The set of processed operational attributes for the |
| | | * entry to add. |
| | | * @return The set of processed operational attributes for the entry to add. |
| | | */ |
| | | public Map<AttributeType,List<Attribute>> |
| | | Map<AttributeType,List<Attribute>> |
| | | getOperationalAttributes(); |
| | | |
| | | |
| | |
| | | * |
| | | * @return The entry to be added to the server. |
| | | */ |
| | | public Entry getEntryToAdd(); |
| | | Entry getEntryToAdd(); |
| | | } |
| | | |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2014 ForgeRock AS |
| | | * Portions Copyright 2014-2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.types.operation; |
| | | import org.forgerock.i18n.LocalizableMessage; |
| | |
| | | * |
| | | * @return The authentication type for this bind operation. |
| | | */ |
| | | public AuthenticationType getAuthenticationType(); |
| | | AuthenticationType getAuthenticationType(); |
| | | |
| | | |
| | | |
| | |
| | | * @return A string representation of the protocol version |
| | | * associated with this bind request. |
| | | */ |
| | | public String getProtocolVersion(); |
| | | String getProtocolVersion(); |
| | | |
| | | |
| | | |
| | |
| | | * @return The raw, unprocessed bind DN for this bind operation as |
| | | * contained in the client request. |
| | | */ |
| | | public ByteString getRawBindDN(); |
| | | ByteString getRawBindDN(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The bind DN for this bind operation. |
| | | */ |
| | | public DN getBindDN(); |
| | | DN getBindDN(); |
| | | |
| | | |
| | | |
| | | /** |
| | | * Retrieves the simple authentication password for this bind |
| | | * operation. |
| | | * Retrieves the simple authentication password for this bind operation. |
| | | * |
| | | * @return The simple authentication password for this bind |
| | | * operation. |
| | | */ |
| | | public ByteString getSimplePassword(); |
| | | ByteString getSimplePassword(); |
| | | |
| | | |
| | | |
| | |
| | | * <CODE>null</CODE> if the bind does not use SASL |
| | | * authentication. |
| | | */ |
| | | public String getSASLMechanism(); |
| | | String getSASLMechanism(); |
| | | |
| | | |
| | | |
| | |
| | | * <CODE>null</CODE> if there are none or if the bind does |
| | | * not use SASL authentication. |
| | | */ |
| | | public ByteString getSASLCredentials(); |
| | | ByteString getSASLCredentials(); |
| | | |
| | | |
| | | |
| | |
| | | * @return The set of server SASL credentials to include in the |
| | | * bind response, or <CODE>null</CODE> if there are none. |
| | | */ |
| | | public ByteString getServerSASLCredentials(); |
| | | ByteString getServerSASLCredentials(); |
| | | |
| | | |
| | | |
| | |
| | | * @param serverSASLCredentials The set of server SASL credentials |
| | | * to include in the bind response. |
| | | */ |
| | | public void setServerSASLCredentials(ByteString |
| | | serverSASLCredentials); |
| | | void setServerSASLCredentials(ByteString serverSASLCredentials); |
| | | |
| | | |
| | | |
| | |
| | | * authentication or the SASL processing was not able to |
| | | * map the request to a user. |
| | | */ |
| | | public Entry getSASLAuthUserEntry(); |
| | | Entry getSASLAuthUserEntry(); |
| | | |
| | | |
| | | |
| | |
| | | * authentication failed, or <CODE>null</CODE> if none is |
| | | * available. |
| | | */ |
| | | public LocalizableMessage getAuthFailureReason(); |
| | | LocalizableMessage getAuthFailureReason(); |
| | | |
| | | |
| | | |
| | |
| | | * @param reason A human-readable message providing the reason |
| | | * that the authentication failed. |
| | | */ |
| | | public void setAuthFailureReason(LocalizableMessage reason); |
| | | void setAuthFailureReason(LocalizableMessage reason); |
| | | |
| | | |
| | | |
| | |
| | | * progressed far enough to identify the user or if the |
| | | * user DN could not be determined. |
| | | */ |
| | | public DN getUserEntryDN(); |
| | | DN getUserEntryDN(); |
| | | } |
| | | |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2014 ForgeRock AS |
| | | * Portions Copyright 2014-2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.types.operation; |
| | | |
| | |
| | | * @return The raw, unprocessed entry DN as included in the client |
| | | * request. |
| | | */ |
| | | public ByteString getRawEntryDN(); |
| | | ByteString getRawEntryDN(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The DN of the entry to compare. |
| | | */ |
| | | public DN getEntryDN(); |
| | | DN getEntryDN(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The raw attribute type for this compare operation. |
| | | */ |
| | | public String getRawAttributeType(); |
| | | String getRawAttributeType(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The attribute type for this compare operation. |
| | | */ |
| | | public AttributeType getAttributeType(); |
| | | AttributeType getAttributeType(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The assertion value for this compare operation. |
| | | */ |
| | | public ByteString getAssertionValue(); |
| | | ByteString getAssertionValue(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The entry to target with the compare operation. |
| | | */ |
| | | public Entry getEntryToCompare(); |
| | | Entry getEntryToCompare(); |
| | | } |
| | | |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2014 ForgeRock AS |
| | | * Portions Copyright 2014-2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.types.operation; |
| | | |
| | |
| | | * @return The raw, unprocessed entry DN as included in the client |
| | | * request. |
| | | */ |
| | | public ByteString getRawEntryDN(); |
| | | ByteString getRawEntryDN(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The DN of the entry to delete. |
| | | */ |
| | | public DN getEntryDN(); |
| | | DN getEntryDN(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The entry to be deleted. |
| | | */ |
| | | public Entry getEntryToDelete(); |
| | | Entry getEntryToDelete(); |
| | | } |
| | | |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2014 ForgeRock AS |
| | | * Portions Copyright 2014-2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.types.operation; |
| | | |
| | |
| | | * @return The OID for the request associated with this extended |
| | | * operation. |
| | | */ |
| | | public String getRequestOID(); |
| | | String getRequestOID(); |
| | | |
| | | |
| | | |
| | |
| | | * @return The value for the request associated with this extended |
| | | * operation. |
| | | */ |
| | | public ByteString getRequestValue(); |
| | | ByteString getRequestValue(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The OID to include in the response to the client. |
| | | */ |
| | | public String getResponseOID(); |
| | | String getResponseOID(); |
| | | |
| | | |
| | | |
| | |
| | | * @param responseOID The OID to include in the response to the |
| | | * client. |
| | | */ |
| | | public void setResponseOID(String responseOID); |
| | | void setResponseOID(String responseOID); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The value to include in the response to the client. |
| | | */ |
| | | public ByteString getResponseValue(); |
| | | ByteString getResponseValue(); |
| | | |
| | | |
| | | |
| | |
| | | * @param responseValue The value to include in the response to |
| | | * the client. |
| | | */ |
| | | public void setResponseValue(ByteString responseValue); |
| | | void setResponseValue(ByteString responseValue); |
| | | } |
| | | |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2014 ForgeRock AS |
| | | * Portions Copyright 2014-2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.types.operation; |
| | | |
| | |
| | | * @return The raw, unprocessed entry DN as included in the client |
| | | * request. |
| | | */ |
| | | public ByteString getRawEntryDN(); |
| | | ByteString getRawEntryDN(); |
| | | |
| | | |
| | | |
| | |
| | | * @return The DN of the entry to rename, or <CODE>null</CODE> if |
| | | * the raw entry DN has not yet been processed. |
| | | */ |
| | | public DN getEntryDN(); |
| | | DN getEntryDN(); |
| | | |
| | | |
| | | |
| | |
| | | * @return The raw, unprocessed newRDN as included in the request |
| | | * from the client. |
| | | */ |
| | | public ByteString getRawNewRDN(); |
| | | ByteString getRawNewRDN(); |
| | | |
| | | |
| | | |
| | |
| | | * @return The new RDN to use for the entry, or <CODE>null</CODE> |
| | | * if the raw newRDN has not yet been processed. |
| | | */ |
| | | public RDN getNewRDN(); |
| | | RDN getNewRDN(); |
| | | |
| | | |
| | | |
| | |
| | | * @return <CODE>true</CODE> if the current RDN value should be |
| | | * removed from the entry, or <CODE>false</CODE> if not. |
| | | */ |
| | | public boolean deleteOldRDN(); |
| | | boolean deleteOldRDN(); |
| | | |
| | | |
| | | |
| | |
| | | * @return The raw, unprocessed newSuperior from the client |
| | | * request, or <CODE>null</CODE> if there is none. |
| | | */ |
| | | public ByteString getRawNewSuperior(); |
| | | ByteString getRawNewSuperior(); |
| | | |
| | | |
| | | |
| | |
| | | * if there is no newSuperior DN for this request or if the |
| | | * raw newSuperior has not yet been processed. |
| | | */ |
| | | public DN getNewSuperior(); |
| | | DN getNewSuperior(); |
| | | |
| | | |
| | | |
| | |
| | | * <CODE>null</CODE> if that information is not yet |
| | | * available (e.g., during pre-parse plugins). |
| | | */ |
| | | public List<Modification> getModifications(); |
| | | List<Modification> getModifications(); |
| | | |
| | | |
| | | |
| | |
| | | * @return The current entry, or <CODE>null</CODE> if it is not yet |
| | | * available. |
| | | */ |
| | | public Entry getOriginalEntry(); |
| | | Entry getOriginalEntry(); |
| | | |
| | | |
| | | |
| | |
| | | * @return The updated entry, or <CODE>null</CODE> if it is not yet |
| | | * available. |
| | | */ |
| | | public Entry getUpdatedEntry(); |
| | | Entry getUpdatedEntry(); |
| | | } |
| | | |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2014 ForgeRock AS |
| | | * Portions Copyright 2014-2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.types.operation; |
| | | |
| | |
| | | * @return The raw, unprocessed entry DN as included in the client |
| | | * request. |
| | | */ |
| | | public ByteString getRawEntryDN(); |
| | | ByteString getRawEntryDN(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The DN of the entry to modify. |
| | | */ |
| | | public DN getEntryDN(); |
| | | DN getEntryDN(); |
| | | |
| | | |
| | | |
| | |
| | | * @return The set of raw, unprocessed modifications as included |
| | | * in the client request. |
| | | */ |
| | | public List<RawModification> getRawModifications(); |
| | | List<RawModification> getRawModifications(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The set of modifications for this modify operation. |
| | | */ |
| | | public List<Modification> getModifications(); |
| | | List<Modification> getModifications(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The current entry before any modifications are applied. |
| | | */ |
| | | public Entry getCurrentEntry(); |
| | | Entry getCurrentEntry(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The modified entry that is to be written to the backend. |
| | | */ |
| | | public Entry getModifiedEntry(); |
| | | Entry getModifiedEntry(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2011-2014 ForgeRock AS. |
| | | * Portions Copyright 2011-2015 ForgeRock AS. |
| | | */ |
| | | package org.opends.server.types.operation; |
| | | import org.forgerock.i18n.LocalizableMessage; |
| | |
| | | * @param control The control to add to the set of controls to |
| | | * include in the response to the client. |
| | | */ |
| | | public void addResponseControl(Control control); |
| | | void addResponseControl(Control control); |
| | | |
| | | |
| | | |
| | |
| | | * @param control The control to remove from the set of controls |
| | | * to include in the response to the client. |
| | | */ |
| | | public void removeResponseControl(Control control); |
| | | void removeResponseControl(Control control); |
| | | |
| | | |
| | | |
| | |
| | | * <CODE>UNDEFINED</CODE> if the operation has not yet |
| | | * completed. |
| | | */ |
| | | public ResultCode getResultCode(); |
| | | ResultCode getResultCode(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @param resultCode The result code for this operation. |
| | | */ |
| | | public void setResultCode(ResultCode resultCode); |
| | | void setResultCode(ResultCode resultCode); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The error message for this operation. |
| | | */ |
| | | public LocalizableMessageBuilder getErrorMessage(); |
| | | LocalizableMessageBuilder getErrorMessage(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @param errorMessage The error message for this operation. |
| | | */ |
| | | public void setErrorMessage(LocalizableMessageBuilder errorMessage); |
| | | void setErrorMessage(LocalizableMessageBuilder errorMessage); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @param message The message to append to the error message |
| | | */ |
| | | public void appendErrorMessage(LocalizableMessage message); |
| | | void appendErrorMessage(LocalizableMessage message); |
| | | |
| | | |
| | | |
| | |
| | | * if the operation has not yet completed or does not have |
| | | * a matched DN. |
| | | */ |
| | | public DN getMatchedDN(); |
| | | DN getMatchedDN(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @param matchedDN The matched DN for this operation. |
| | | */ |
| | | public void setMatchedDN(DN matchedDN); |
| | | void setMatchedDN(DN matchedDN); |
| | | |
| | | |
| | | |
| | |
| | | * <CODE>null</CODE> if the operation is not yet complete |
| | | * or does not have a set of referral URLs. |
| | | */ |
| | | public List<String> getReferralURLs(); |
| | | List<String> getReferralURLs(); |
| | | |
| | | |
| | | |
| | | /** |
| | | * Specifies the set of referral URLs for this operation. |
| | | * |
| | | * @param referralURLs The set of referral URLs for this |
| | | * operation. |
| | | * @param referralURLs The set of referral URLs for this operation. |
| | | */ |
| | | public void setReferralURLs(List<String> referralURLs); |
| | | void setReferralURLs(List<String> referralURLs); |
| | | |
| | | |
| | | |
| | |
| | | * <CODE>DirectoryException</CODE> object. |
| | | * |
| | | * @param directoryException The exception containing the |
| | | * information to use for the response |
| | | * elements. |
| | | * information to use for the response elements. |
| | | */ |
| | | public void setResponseData(DirectoryException directoryException); |
| | | void setResponseData(DirectoryException directoryException); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The authorization DN for this operation. |
| | | */ |
| | | public DN getAuthorizationDN(); |
| | | DN getAuthorizationDN(); |
| | | |
| | | |
| | | |
| | |
| | | * @return An unmodifiable list containing the additional log items for this |
| | | * operation. |
| | | */ |
| | | public List<AdditionalLogItem> getAdditionalLogItems(); |
| | | List<AdditionalLogItem> getAdditionalLogItems(); |
| | | |
| | | |
| | | |
| | |
| | | * @param item |
| | | * The additional log item for this operation. |
| | | */ |
| | | public void addAdditionalLogItem(AdditionalLogItem item); |
| | | void addAdditionalLogItem(AdditionalLogItem item); |
| | | } |
| | | |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2013-2014 ForgeRock AS. |
| | | * Portions Copyright 2013-2015 ForgeRock AS. |
| | | */ |
| | | package org.opends.server.types.operation; |
| | | |
| | |
| | | * @return The raw, unprocessed base DN as included in the request |
| | | * from the client. |
| | | */ |
| | | public ByteString getRawBaseDN(); |
| | | ByteString getRawBaseDN(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The base DN for this search operation. |
| | | */ |
| | | public DN getBaseDN(); |
| | | DN getBaseDN(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The scope for this search operation. |
| | | */ |
| | | public SearchScope getScope(); |
| | | SearchScope getScope(); |
| | | |
| | | |
| | | |
| | |
| | | * @return The alias dereferencing policy for this search |
| | | * operation. |
| | | */ |
| | | public DereferenceAliasesPolicy getDerefPolicy(); |
| | | DereferenceAliasesPolicy getDerefPolicy(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The size limit for this search operation. |
| | | */ |
| | | public int getSizeLimit(); |
| | | int getSizeLimit(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The time limit for this search operation. |
| | | */ |
| | | public int getTimeLimit(); |
| | | int getTimeLimit(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The typesOnly flag for this search operation. |
| | | */ |
| | | public boolean getTypesOnly(); |
| | | boolean getTypesOnly(); |
| | | |
| | | |
| | | |
| | |
| | | * @return The raw, unprocessed search filter as included in the |
| | | * request from the client. |
| | | */ |
| | | public RawFilter getRawFilter(); |
| | | RawFilter getRawFilter(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The filter for this search operation. |
| | | */ |
| | | public SearchFilter getFilter(); |
| | | SearchFilter getFilter(); |
| | | |
| | | |
| | | |
| | |
| | | * @return The set of requested attributes for this search |
| | | * operation. |
| | | */ |
| | | public Set<String> getAttributes(); |
| | | Set<String> getAttributes(); |
| | | |
| | | |
| | | |
| | |
| | | * @return The number of entries sent to the client for this search |
| | | * operation. |
| | | */ |
| | | public int getEntriesSent(); |
| | | int getEntriesSent(); |
| | | |
| | | |
| | | |
| | |
| | | * @return The number of search references sent to the client for |
| | | * this search operation. |
| | | */ |
| | | public int getReferencesSent(); |
| | | int getReferencesSent(); |
| | | } |
| | | |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2014 ForgeRock AS |
| | | * Portions Copyright 2014-2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.types.operation; |
| | | |
| | |
| | | * |
| | | * @return The DN of the entry in a raw, unparsed form. |
| | | */ |
| | | public ByteString getRawEntryDN(); |
| | | ByteString getRawEntryDN(); |
| | | |
| | | |
| | | |
| | |
| | | * @return The set of attributes in their raw, unparsed form as |
| | | * read from the client request. |
| | | */ |
| | | public List<RawAttribute> getRawAttributes(); |
| | | List<RawAttribute> getRawAttributes(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The DN of the entry to add. |
| | | */ |
| | | public DN getEntryDN(); |
| | | DN getEntryDN(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The set of processed objectclasses for the entry to add. |
| | | */ |
| | | public Map<ObjectClass,String> getObjectClasses(); |
| | | Map<ObjectClass,String> getObjectClasses(); |
| | | |
| | | |
| | | |
| | |
| | | * @return The set of processed user attributes for the entry to |
| | | * add. |
| | | */ |
| | | public Map<AttributeType,List<Attribute>> getUserAttributes(); |
| | | Map<AttributeType,List<Attribute>> getUserAttributes(); |
| | | |
| | | |
| | | |
| | |
| | | * @return The set of processed operational attributes for the |
| | | * entry to add. |
| | | */ |
| | | public Map<AttributeType,List<Attribute>> |
| | | getOperationalAttributes(); |
| | | |
| | | |
| | | Map<AttributeType, List<Attribute>> getOperationalAttributes(); |
| | | |
| | | /** |
| | | * Retrieves the entry to be added to the server. The contents of |
| | |
| | | * |
| | | * @return The entry to be added to the server. |
| | | */ |
| | | public Entry getEntryToAdd(); |
| | | Entry getEntryToAdd(); |
| | | } |
| | | |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2014 ForgeRock AS |
| | | * Portions Copyright 2014-2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.types.operation; |
| | | import org.forgerock.i18n.LocalizableMessage; |
| | |
| | | * |
| | | * @return The authentication type for this bind operation. |
| | | */ |
| | | public AuthenticationType getAuthenticationType(); |
| | | AuthenticationType getAuthenticationType(); |
| | | |
| | | |
| | | |
| | |
| | | * @return A string representation of the protocol version |
| | | * associated with this bind request. |
| | | */ |
| | | public String getProtocolVersion(); |
| | | String getProtocolVersion(); |
| | | |
| | | |
| | | |
| | |
| | | * @return The raw, unprocessed bind DN for this bind operation as |
| | | * contained in the client request. |
| | | */ |
| | | public ByteString getRawBindDN(); |
| | | ByteString getRawBindDN(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The bind DN for this bind operation. |
| | | */ |
| | | public DN getBindDN(); |
| | | DN getBindDN(); |
| | | |
| | | |
| | | |
| | |
| | | * @return The simple authentication password for this bind |
| | | * operation. |
| | | */ |
| | | public ByteString getSimplePassword(); |
| | | ByteString getSimplePassword(); |
| | | |
| | | |
| | | |
| | |
| | | * <CODE>null</CODE> if the bind does not use SASL |
| | | * authentication. |
| | | */ |
| | | public String getSASLMechanism(); |
| | | String getSASLMechanism(); |
| | | |
| | | |
| | | |
| | |
| | | * <CODE>null</CODE> if there are none or if the bind does |
| | | * not use SASL authentication. |
| | | */ |
| | | public ByteString getSASLCredentials(); |
| | | ByteString getSASLCredentials(); |
| | | |
| | | |
| | | |
| | |
| | | * @return The set of server SASL credentials to include in the |
| | | * bind response, or <CODE>null</CODE> if there are none. |
| | | */ |
| | | public ByteString getServerSASLCredentials(); |
| | | ByteString getServerSASLCredentials(); |
| | | |
| | | |
| | | |
| | |
| | | * authentication or the SASL processing was not able to |
| | | * map the request to a user. |
| | | */ |
| | | public Entry getSASLAuthUserEntry(); |
| | | Entry getSASLAuthUserEntry(); |
| | | |
| | | |
| | | |
| | |
| | | * authentication failed, or <CODE>null</CODE> if none is |
| | | * available. |
| | | */ |
| | | public LocalizableMessage getAuthFailureReason(); |
| | | LocalizableMessage getAuthFailureReason(); |
| | | |
| | | |
| | | |
| | |
| | | * progressed far enough to identify the user or if the |
| | | * user DN could not be determined. |
| | | */ |
| | | public DN getUserEntryDN(); |
| | | DN getUserEntryDN(); |
| | | } |
| | | |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2014 ForgeRock AS |
| | | * Portions Copyright 2014-2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.types.operation; |
| | | |
| | |
| | | * @return The raw, unprocessed entry DN as included in the client |
| | | * request. |
| | | */ |
| | | public ByteString getRawEntryDN(); |
| | | ByteString getRawEntryDN(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The DN of the entry to compare. |
| | | */ |
| | | public DN getEntryDN(); |
| | | DN getEntryDN(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The raw attribute type for this compare operation. |
| | | */ |
| | | public String getRawAttributeType(); |
| | | String getRawAttributeType(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The attribute type for this compare operation. |
| | | */ |
| | | public AttributeType getAttributeType(); |
| | | AttributeType getAttributeType(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The assertion value for this compare operation. |
| | | */ |
| | | public ByteString getAssertionValue(); |
| | | ByteString getAssertionValue(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The entry to target with the compare operation. |
| | | */ |
| | | public Entry getEntryToCompare(); |
| | | Entry getEntryToCompare(); |
| | | } |
| | | |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2014 ForgeRock AS |
| | | * Portions Copyright 2014-2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.types.operation; |
| | | |
| | |
| | | * @return The raw, unprocessed entry DN as included in the client |
| | | * request. |
| | | */ |
| | | public ByteString getRawEntryDN(); |
| | | ByteString getRawEntryDN(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The DN of the entry to delete. |
| | | */ |
| | | public DN getEntryDN(); |
| | | DN getEntryDN(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The entry to be deleted. |
| | | */ |
| | | public Entry getEntryToDelete(); |
| | | Entry getEntryToDelete(); |
| | | } |
| | | |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2014 ForgeRock AS |
| | | * Portions Copyright 2014-2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.types.operation; |
| | | |
| | |
| | | * @return The OID for the request associated with this extended |
| | | * operation. |
| | | */ |
| | | public String getRequestOID(); |
| | | String getRequestOID(); |
| | | |
| | | |
| | | |
| | |
| | | * @return The value for the request associated with this extended |
| | | * operation. |
| | | */ |
| | | public ByteString getRequestValue(); |
| | | ByteString getRequestValue(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The OID to include in the response to the client. |
| | | */ |
| | | public String getResponseOID(); |
| | | String getResponseOID(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The value to include in the response to the client. |
| | | */ |
| | | public ByteString getResponseValue(); |
| | | ByteString getResponseValue(); |
| | | } |
| | | |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2014 ForgeRock AS |
| | | * Portions Copyright 2014-2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.types.operation; |
| | | |
| | |
| | | * @return The raw, unprocessed entry DN as included in the client |
| | | * request. |
| | | */ |
| | | public ByteString getRawEntryDN(); |
| | | ByteString getRawEntryDN(); |
| | | |
| | | |
| | | |
| | |
| | | * @return The DN of the entry to rename, or <CODE>null</CODE> if |
| | | * the raw entry DN has not yet been processed. |
| | | */ |
| | | public DN getEntryDN(); |
| | | DN getEntryDN(); |
| | | |
| | | |
| | | |
| | |
| | | * @return The raw, unprocessed newRDN as included in the request |
| | | * from the client. |
| | | */ |
| | | public ByteString getRawNewRDN(); |
| | | ByteString getRawNewRDN(); |
| | | |
| | | |
| | | |
| | |
| | | * @return The new RDN to use for the entry, or <CODE>null</CODE> |
| | | * if the raw newRDN has not yet been processed. |
| | | */ |
| | | public RDN getNewRDN(); |
| | | RDN getNewRDN(); |
| | | |
| | | |
| | | |
| | |
| | | * @return <CODE>true</CODE> if the current RDN value should be |
| | | * removed from the entry, or <CODE>false</CODE> if not. |
| | | */ |
| | | public boolean deleteOldRDN(); |
| | | boolean deleteOldRDN(); |
| | | |
| | | |
| | | |
| | |
| | | * @return The raw, unprocessed newSuperior from the client |
| | | * request, or <CODE>null</CODE> if there is none. |
| | | */ |
| | | public ByteString getRawNewSuperior(); |
| | | ByteString getRawNewSuperior(); |
| | | |
| | | |
| | | |
| | |
| | | * if there is no newSuperior DN for this request or if the |
| | | * raw newSuperior has not yet been processed. |
| | | */ |
| | | public DN getNewSuperior(); |
| | | DN getNewSuperior(); |
| | | |
| | | |
| | | |
| | |
| | | * <CODE>null</CODE> if that information is not yet |
| | | * available (e.g., during pre-parse plugins). |
| | | */ |
| | | public List<Modification> getModifications(); |
| | | List<Modification> getModifications(); |
| | | |
| | | |
| | | |
| | |
| | | * @return The current entry, or <CODE>null</CODE> if it is not yet |
| | | * available. |
| | | */ |
| | | public Entry getOriginalEntry(); |
| | | Entry getOriginalEntry(); |
| | | |
| | | |
| | | |
| | |
| | | * @return The updated entry, or <CODE>null</CODE> if it is not yet |
| | | * available. |
| | | */ |
| | | public Entry getUpdatedEntry(); |
| | | Entry getUpdatedEntry(); |
| | | } |
| | | |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2014 ForgeRock AS |
| | | * Portions Copyright 2014-2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.types.operation; |
| | | |
| | |
| | | * @return The raw, unprocessed entry DN as included in the client |
| | | * request. |
| | | */ |
| | | public ByteString getRawEntryDN(); |
| | | ByteString getRawEntryDN(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The DN of the entry to modify. |
| | | */ |
| | | public DN getEntryDN(); |
| | | DN getEntryDN(); |
| | | |
| | | |
| | | |
| | |
| | | * @return The set of raw, unprocessed modifications as included |
| | | * in the client request. |
| | | */ |
| | | public List<RawModification> getRawModifications(); |
| | | List<RawModification> getRawModifications(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The set of modifications for this modify operation. |
| | | */ |
| | | public List<Modification> getModifications(); |
| | | List<Modification> getModifications(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The current entry before any modifications are applied. |
| | | */ |
| | | public Entry getCurrentEntry(); |
| | | Entry getCurrentEntry(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The modified entry that is to be written to the backend. |
| | | */ |
| | | public Entry getModifiedEntry(); |
| | | Entry getModifiedEntry(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2011-2014 ForgeRock AS. |
| | | * Portions Copyright 2011-2015 ForgeRock AS. |
| | | */ |
| | | package org.opends.server.types.operation; |
| | | import org.forgerock.i18n.LocalizableMessageBuilder; |
| | |
| | | * <CODE>UNDEFINED</CODE> if the operation has not yet |
| | | * completed. |
| | | */ |
| | | public ResultCode getResultCode(); |
| | | ResultCode getResultCode(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The error message for this operation. |
| | | */ |
| | | public LocalizableMessageBuilder getErrorMessage(); |
| | | LocalizableMessageBuilder getErrorMessage(); |
| | | |
| | | |
| | | |
| | |
| | | * if the operation has not yet completed or does not have |
| | | * a matched DN. |
| | | */ |
| | | public DN getMatchedDN(); |
| | | DN getMatchedDN(); |
| | | |
| | | |
| | | |
| | |
| | | * <CODE>null</CODE> if the operation is not yet complete |
| | | * or does not have a set of referral URLs. |
| | | */ |
| | | public List<String> getReferralURLs(); |
| | | List<String> getReferralURLs(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The authorization DN for this operation. |
| | | */ |
| | | public DN getAuthorizationDN(); |
| | | DN getAuthorizationDN(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The time that processing stopped for this operation. |
| | | */ |
| | | public long getProcessingStopTime(); |
| | | long getProcessingStopTime(); |
| | | |
| | | |
| | | |
| | |
| | | * @return The length of time in milliseconds that the server spent |
| | | * processing this operation. |
| | | */ |
| | | public long getProcessingTime(); |
| | | long getProcessingTime(); |
| | | |
| | | |
| | | |
| | |
| | | * @return An unmodifiable list containing the additional log items for this |
| | | * operation. |
| | | */ |
| | | public List<AdditionalLogItem> getAdditionalLogItems(); |
| | | List<AdditionalLogItem> getAdditionalLogItems(); |
| | | } |
| | | |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2013-2014 ForgeRock AS. |
| | | * Portions Copyright 2013-2015 ForgeRock AS. |
| | | */ |
| | | package org.opends.server.types.operation; |
| | | |
| | |
| | | * @return The raw, unprocessed base DN as included in the request |
| | | * from the client. |
| | | */ |
| | | public ByteString getRawBaseDN(); |
| | | ByteString getRawBaseDN(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The base DN for this search operation. |
| | | */ |
| | | public DN getBaseDN(); |
| | | DN getBaseDN(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The scope for this search operation. |
| | | */ |
| | | public SearchScope getScope(); |
| | | SearchScope getScope(); |
| | | |
| | | |
| | | |
| | |
| | | * @return The alias dereferencing policy for this search |
| | | * operation. |
| | | */ |
| | | public DereferenceAliasesPolicy getDerefPolicy(); |
| | | DereferenceAliasesPolicy getDerefPolicy(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The size limit for this search operation. |
| | | */ |
| | | public int getSizeLimit(); |
| | | int getSizeLimit(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The time limit for this search operation. |
| | | */ |
| | | public int getTimeLimit(); |
| | | int getTimeLimit(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The typesOnly flag for this search operation. |
| | | */ |
| | | public boolean getTypesOnly(); |
| | | boolean getTypesOnly(); |
| | | |
| | | |
| | | |
| | |
| | | * @return The raw, unprocessed search filter as included in the |
| | | * request from the client. |
| | | */ |
| | | public RawFilter getRawFilter(); |
| | | RawFilter getRawFilter(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The filter for this search operation. |
| | | */ |
| | | public SearchFilter getFilter(); |
| | | SearchFilter getFilter(); |
| | | |
| | | |
| | | |
| | |
| | | * @return The set of requested attributes for this search |
| | | * operation. |
| | | */ |
| | | public Set<String> getAttributes(); |
| | | Set<String> getAttributes(); |
| | | |
| | | |
| | | |
| | |
| | | * @return The number of entries sent to the client for this search |
| | | * operation. |
| | | */ |
| | | public int getEntriesSent(); |
| | | int getEntriesSent(); |
| | | |
| | | |
| | | |
| | |
| | | * @return The number of search references sent to the client for |
| | | * this search operation. |
| | | */ |
| | | public int getReferencesSent(); |
| | | int getReferencesSent(); |
| | | } |
| | | |
| | |
| | | * |
| | | * |
| | | * Copyright 2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2014 ForgeRock AS |
| | | * Portions Copyright 2014-2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.types.operation; |
| | | |
| | |
| | | * |
| | | * @return The DN of the entry in a raw, unparsed form. |
| | | */ |
| | | public ByteString getRawEntryDN(); |
| | | ByteString getRawEntryDN(); |
| | | |
| | | |
| | | |
| | |
| | | * @return The set of attributes in their raw, unparsed form as |
| | | * read from the client request. |
| | | */ |
| | | public List<RawAttribute> getRawAttributes(); |
| | | List<RawAttribute> getRawAttributes(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The DN of the entry to add. |
| | | */ |
| | | public DN getEntryDN(); |
| | | DN getEntryDN(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The set of processed objectclasses for the entry to add. |
| | | */ |
| | | public Map<ObjectClass,String> getObjectClasses(); |
| | | Map<ObjectClass,String> getObjectClasses(); |
| | | |
| | | |
| | | |
| | |
| | | * @return The set of processed user attributes for the entry to |
| | | * add. |
| | | */ |
| | | public Map<AttributeType,List<Attribute>> getUserAttributes(); |
| | | Map<AttributeType,List<Attribute>> getUserAttributes(); |
| | | |
| | | |
| | | |
| | |
| | | * @return The set of processed operational attributes for the |
| | | * entry to add. |
| | | */ |
| | | public Map<AttributeType,List<Attribute>> |
| | | Map<AttributeType,List<Attribute>> |
| | | getOperationalAttributes(); |
| | | |
| | | |
| | |
| | | * |
| | | * @return The entry to be added to the server. |
| | | */ |
| | | public Entry getEntryToAdd(); |
| | | Entry getEntryToAdd(); |
| | | } |
| | | |
| | |
| | | * |
| | | * |
| | | * Copyright 2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2014 ForgeRock AS |
| | | * Portions Copyright 2014-2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.types.operation; |
| | | |
| | |
| | | * @return The raw, unprocessed entry DN as included in the client |
| | | * request. |
| | | */ |
| | | public ByteString getRawEntryDN(); |
| | | ByteString getRawEntryDN(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The DN of the entry to delete. |
| | | */ |
| | | public DN getEntryDN(); |
| | | DN getEntryDN(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The entry to be deleted. |
| | | */ |
| | | public Entry getEntryToDelete(); |
| | | Entry getEntryToDelete(); |
| | | } |
| | | |
| | |
| | | * |
| | | * |
| | | * Copyright 2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2014 ForgeRock AS |
| | | * Portions Copyright 2014-2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.types.operation; |
| | | |
| | |
| | | * @return The raw, unprocessed entry DN as included in the client |
| | | * request. |
| | | */ |
| | | public ByteString getRawEntryDN(); |
| | | ByteString getRawEntryDN(); |
| | | |
| | | |
| | | |
| | |
| | | * @return The DN of the entry to rename, or <CODE>null</CODE> if |
| | | * the raw entry DN has not yet been processed. |
| | | */ |
| | | public DN getEntryDN(); |
| | | DN getEntryDN(); |
| | | |
| | | |
| | | |
| | |
| | | * @return The raw, unprocessed newRDN as included in the request |
| | | * from the client. |
| | | */ |
| | | public ByteString getRawNewRDN(); |
| | | ByteString getRawNewRDN(); |
| | | |
| | | |
| | | |
| | |
| | | * @return The new RDN to use for the entry, or <CODE>null</CODE> |
| | | * if the raw newRDN has not yet been processed. |
| | | */ |
| | | public RDN getNewRDN(); |
| | | RDN getNewRDN(); |
| | | |
| | | |
| | | |
| | |
| | | * @return <CODE>true</CODE> if the current RDN value should be |
| | | * removed from the entry, or <CODE>false</CODE> if not. |
| | | */ |
| | | public boolean deleteOldRDN(); |
| | | boolean deleteOldRDN(); |
| | | |
| | | |
| | | |
| | |
| | | * @return The raw, unprocessed newSuperior from the client |
| | | * request, or <CODE>null</CODE> if there is none. |
| | | */ |
| | | public ByteString getRawNewSuperior(); |
| | | ByteString getRawNewSuperior(); |
| | | |
| | | |
| | | |
| | |
| | | * if there is no newSuperior DN for this request or if the |
| | | * raw newSuperior has not yet been processed. |
| | | */ |
| | | public DN getNewSuperior(); |
| | | DN getNewSuperior(); |
| | | |
| | | |
| | | |
| | |
| | | * <CODE>null</CODE> if that information is not yet |
| | | * available (e.g., during pre-parse plugins). |
| | | */ |
| | | public List<Modification> getModifications(); |
| | | List<Modification> getModifications(); |
| | | |
| | | |
| | | |
| | |
| | | * @return The current entry, or <CODE>null</CODE> if it is not yet |
| | | * available. |
| | | */ |
| | | public Entry getOriginalEntry(); |
| | | Entry getOriginalEntry(); |
| | | |
| | | |
| | | |
| | |
| | | * @return The updated entry, or <CODE>null</CODE> if it is not yet |
| | | * available. |
| | | */ |
| | | public Entry getUpdatedEntry(); |
| | | Entry getUpdatedEntry(); |
| | | } |
| | | |
| | |
| | | * |
| | | * |
| | | * Copyright 2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2014 ForgeRock AS |
| | | * Portions Copyright 2014-2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.types.operation; |
| | | |
| | |
| | | * @return The raw, unprocessed entry DN as included in the client |
| | | * request. |
| | | */ |
| | | public ByteString getRawEntryDN(); |
| | | ByteString getRawEntryDN(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The DN of the entry to modify. |
| | | */ |
| | | public DN getEntryDN(); |
| | | DN getEntryDN(); |
| | | |
| | | |
| | | |
| | |
| | | * @return The set of raw, unprocessed modifications as included |
| | | * in the client request. |
| | | */ |
| | | public List<RawModification> getRawModifications(); |
| | | List<RawModification> getRawModifications(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The set of modifications for this modify operation. |
| | | */ |
| | | public List<Modification> getModifications(); |
| | | List<Modification> getModifications(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The current entry before any modifications are applied. |
| | | */ |
| | | public Entry getCurrentEntry(); |
| | | Entry getCurrentEntry(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The modified entry that is to be written to the backend. |
| | | */ |
| | | public Entry getModifiedEntry(); |
| | | Entry getModifiedEntry(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * |
| | | * Copyright 2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2011-2014 ForgeRock AS. |
| | | * Portions Copyright 2011-2015 ForgeRock AS. |
| | | */ |
| | | package org.opends.server.types.operation; |
| | | import org.forgerock.i18n.LocalizableMessageBuilder; |
| | |
| | | * <CODE>UNDEFINED</CODE> if the operation has not yet |
| | | * completed. |
| | | */ |
| | | public ResultCode getResultCode(); |
| | | ResultCode getResultCode(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The error message for this operation. |
| | | */ |
| | | public LocalizableMessageBuilder getErrorMessage(); |
| | | LocalizableMessageBuilder getErrorMessage(); |
| | | |
| | | |
| | | |
| | |
| | | * if the operation has not yet completed or does not have |
| | | * a matched DN. |
| | | */ |
| | | public DN getMatchedDN(); |
| | | DN getMatchedDN(); |
| | | |
| | | |
| | | |
| | |
| | | * <CODE>null</CODE> if the operation is not yet complete |
| | | * or does not have a set of referral URLs. |
| | | */ |
| | | public List<String> getReferralURLs(); |
| | | List<String> getReferralURLs(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The authorization DN for this operation. |
| | | */ |
| | | public DN getAuthorizationDN(); |
| | | DN getAuthorizationDN(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The time that processing stopped for this operation. |
| | | */ |
| | | public long getProcessingStopTime(); |
| | | long getProcessingStopTime(); |
| | | |
| | | |
| | | |
| | |
| | | * @return The length of time in milliseconds that the server spent |
| | | * processing this operation. |
| | | */ |
| | | public long getProcessingTime(); |
| | | long getProcessingTime(); |
| | | |
| | | |
| | | |
| | |
| | | * @return An unmodifiable list containing the additional log items for this |
| | | * operation. |
| | | */ |
| | | public List<AdditionalLogItem> getAdditionalLogItems(); |
| | | List<AdditionalLogItem> getAdditionalLogItems(); |
| | | } |
| | | |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2014 ForgeRock AS |
| | | * Portions Copyright 2014-2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.types.operation; |
| | | |
| | |
| | | * |
| | | * @return The DN of the entry in a raw, unparsed form. |
| | | */ |
| | | public ByteString getRawEntryDN(); |
| | | ByteString getRawEntryDN(); |
| | | |
| | | |
| | | |
| | |
| | | * @return The set of attributes in their raw, unparsed form as |
| | | * read from the client request. |
| | | */ |
| | | public List<RawAttribute> getRawAttributes(); |
| | | List<RawAttribute> getRawAttributes(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The DN of the entry to add. |
| | | */ |
| | | public DN getEntryDN(); |
| | | DN getEntryDN(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The set of processed objectclasses for the entry to add. |
| | | */ |
| | | public Map<ObjectClass,String> getObjectClasses(); |
| | | Map<ObjectClass,String> getObjectClasses(); |
| | | |
| | | |
| | | |
| | |
| | | * @param objectClass The objectclass to add to the entry. |
| | | * @param name The name to use for the objectclass. |
| | | */ |
| | | public void addObjectClass(ObjectClass objectClass, String name); |
| | | void addObjectClass(ObjectClass objectClass, String name); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @param objectClass The objectclass to remove from the entry. |
| | | */ |
| | | public void removeObjectClass(ObjectClass objectClass); |
| | | void removeObjectClass(ObjectClass objectClass); |
| | | |
| | | |
| | | |
| | |
| | | * @return The set of processed user attributes for the entry to |
| | | * add. |
| | | */ |
| | | public Map<AttributeType,List<Attribute>> getUserAttributes(); |
| | | Map<AttributeType,List<Attribute>> getUserAttributes(); |
| | | |
| | | |
| | | |
| | |
| | | * @return The set of processed operational attributes for the |
| | | * entry to add. |
| | | */ |
| | | public Map<AttributeType,List<Attribute>> |
| | | getOperationalAttributes(); |
| | | Map<AttributeType, List<Attribute>> getOperationalAttributes(); |
| | | |
| | | |
| | | |
| | |
| | | * @param attributeList The attribute list for the provided |
| | | * attribute type. |
| | | */ |
| | | public void setAttribute(AttributeType attributeType, |
| | | List<Attribute> attributeList); |
| | | void setAttribute(AttributeType attributeType, List<Attribute> attributeList); |
| | | |
| | | |
| | | |
| | |
| | | * @param attributeType The attribute tyep for the attribute to |
| | | * remove. |
| | | */ |
| | | public void removeAttribute(AttributeType attributeType); |
| | | void removeAttribute(AttributeType attributeType); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The entry to be added to the server. |
| | | */ |
| | | public Entry getEntryToAdd(); |
| | | Entry getEntryToAdd(); |
| | | } |
| | | |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2014 ForgeRock AS |
| | | * Portions Copyright 2014-2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.types.operation; |
| | | import org.forgerock.i18n.LocalizableMessage; |
| | |
| | | * |
| | | * @return The authentication type for this bind operation. |
| | | */ |
| | | public AuthenticationType getAuthenticationType(); |
| | | AuthenticationType getAuthenticationType(); |
| | | |
| | | |
| | | |
| | |
| | | * @return A string representation of the protocol version |
| | | * associated with this bind request. |
| | | */ |
| | | public String getProtocolVersion(); |
| | | String getProtocolVersion(); |
| | | |
| | | |
| | | |
| | |
| | | * @return The raw, unprocessed bind DN for this bind operation as |
| | | * contained in the client request. |
| | | */ |
| | | public ByteString getRawBindDN(); |
| | | ByteString getRawBindDN(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The bind DN for this bind operation. |
| | | */ |
| | | public DN getBindDN(); |
| | | DN getBindDN(); |
| | | |
| | | |
| | | |
| | |
| | | * @return The simple authentication password for this bind |
| | | * operation. |
| | | */ |
| | | public ByteString getSimplePassword(); |
| | | ByteString getSimplePassword(); |
| | | |
| | | |
| | | |
| | |
| | | * <CODE>null</CODE> if the bind does not use SASL |
| | | * authentication. |
| | | */ |
| | | public String getSASLMechanism(); |
| | | String getSASLMechanism(); |
| | | |
| | | |
| | | |
| | |
| | | * <CODE>null</CODE> if there are none or if the bind does |
| | | * not use SASL authentication. |
| | | */ |
| | | public ByteString getSASLCredentials(); |
| | | ByteString getSASLCredentials(); |
| | | |
| | | |
| | | |
| | |
| | | * @param serverSASLCredentials The set of server SASL credentials |
| | | * to include in the bind response. |
| | | */ |
| | | public void setServerSASLCredentials(ByteString |
| | | serverSASLCredentials); |
| | | void setServerSASLCredentials(ByteString serverSASLCredentials); |
| | | |
| | | |
| | | |
| | |
| | | * @param reason A human-readable message providing the reason |
| | | * that the authentication failed. |
| | | */ |
| | | public void setAuthFailureReason(LocalizableMessage reason); |
| | | void setAuthFailureReason(LocalizableMessage reason); |
| | | |
| | | |
| | | |
| | |
| | | * progressed far enough to identify the user or if the |
| | | * user DN could not be determined. |
| | | */ |
| | | public DN getUserEntryDN(); |
| | | DN getUserEntryDN(); |
| | | } |
| | | |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2014 ForgeRock AS |
| | | * Portions Copyright 2014-2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.types.operation; |
| | | |
| | |
| | | * @return The raw, unprocessed entry DN as included in the client |
| | | * request. |
| | | */ |
| | | public ByteString getRawEntryDN(); |
| | | ByteString getRawEntryDN(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The DN of the entry to compare. |
| | | */ |
| | | public DN getEntryDN(); |
| | | DN getEntryDN(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The raw attribute type for this compare operation. |
| | | */ |
| | | public String getRawAttributeType(); |
| | | String getRawAttributeType(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The attribute type for this compare operation. |
| | | */ |
| | | public AttributeType getAttributeType(); |
| | | AttributeType getAttributeType(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The assertion value for this compare operation. |
| | | */ |
| | | public ByteString getAssertionValue(); |
| | | ByteString getAssertionValue(); |
| | | |
| | | |
| | | |
| | |
| | | * @param assertionValue The assertion value for this compare |
| | | * operation. |
| | | */ |
| | | public void setAssertionValue(ByteString assertionValue); |
| | | void setAssertionValue(ByteString assertionValue); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The entry to target with the compare operation. |
| | | */ |
| | | public Entry getEntryToCompare(); |
| | | Entry getEntryToCompare(); |
| | | } |
| | | |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2014 ForgeRock AS |
| | | * Portions Copyright 2014-2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.types.operation; |
| | | |
| | |
| | | * @return The raw, unprocessed entry DN as included in the client |
| | | * request. |
| | | */ |
| | | public ByteString getRawEntryDN(); |
| | | ByteString getRawEntryDN(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The DN of the entry to delete. |
| | | */ |
| | | public DN getEntryDN(); |
| | | DN getEntryDN(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The entry to be deleted. |
| | | */ |
| | | public Entry getEntryToDelete(); |
| | | Entry getEntryToDelete(); |
| | | } |
| | | |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2014 ForgeRock AS |
| | | * Portions Copyright 2014-2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.types.operation; |
| | | |
| | |
| | | * @return The OID for the request associated with this extended |
| | | * operation. |
| | | */ |
| | | public String getRequestOID(); |
| | | String getRequestOID(); |
| | | |
| | | |
| | | |
| | |
| | | * @return The value for the request associated with this extended |
| | | * operation. |
| | | */ |
| | | public ByteString getRequestValue(); |
| | | ByteString getRequestValue(); |
| | | |
| | | |
| | | |
| | |
| | | * @param responseOID The OID to include in the response to the |
| | | * client. |
| | | */ |
| | | public void setResponseOID(String responseOID); |
| | | void setResponseOID(String responseOID); |
| | | |
| | | |
| | | |
| | |
| | | * @param responseValue The value to include in the response to |
| | | * the client. |
| | | */ |
| | | public void setResponseValue(ByteString responseValue); |
| | | void setResponseValue(ByteString responseValue); |
| | | } |
| | | |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2014 ForgeRock AS |
| | | * Portions Copyright 2014-2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.types.operation; |
| | | |
| | |
| | | * @return The raw, unprocessed entry DN as included in the client |
| | | * request. |
| | | */ |
| | | public ByteString getRawEntryDN(); |
| | | ByteString getRawEntryDN(); |
| | | |
| | | |
| | | |
| | |
| | | * @return The DN of the entry to rename, or <CODE>null</CODE> if |
| | | * the raw entry DN has not yet been processed. |
| | | */ |
| | | public DN getEntryDN(); |
| | | DN getEntryDN(); |
| | | |
| | | |
| | | |
| | |
| | | * @return The raw, unprocessed newRDN as included in the request |
| | | * from the client. |
| | | */ |
| | | public ByteString getRawNewRDN(); |
| | | ByteString getRawNewRDN(); |
| | | |
| | | |
| | | |
| | |
| | | * @return The new RDN to use for the entry, or <CODE>null</CODE> |
| | | * if the raw newRDN has not yet been processed. |
| | | */ |
| | | public RDN getNewRDN(); |
| | | RDN getNewRDN(); |
| | | |
| | | |
| | | |
| | |
| | | * @return <CODE>true</CODE> if the current RDN value should be |
| | | * removed from the entry, or <CODE>false</CODE> if not. |
| | | */ |
| | | public boolean deleteOldRDN(); |
| | | boolean deleteOldRDN(); |
| | | |
| | | |
| | | |
| | |
| | | * @return The raw, unprocessed newSuperior from the client |
| | | * request, or <CODE>null</CODE> if there is none. |
| | | */ |
| | | public ByteString getRawNewSuperior(); |
| | | ByteString getRawNewSuperior(); |
| | | |
| | | |
| | | |
| | |
| | | * if there is no newSuperior DN for this request or if the |
| | | * raw newSuperior has not yet been processed. |
| | | */ |
| | | public DN getNewSuperior(); |
| | | DN getNewSuperior(); |
| | | |
| | | |
| | | |
| | |
| | | * <CODE>null</CODE> if that information is not yet |
| | | * available (e.g., during pre-parse plugins). |
| | | */ |
| | | public List<Modification> getModifications(); |
| | | List<Modification> getModifications(); |
| | | |
| | | |
| | | |
| | |
| | | * @param modification The modification to add to the set of |
| | | * modifications to apply to the entry. |
| | | */ |
| | | public void addModification(Modification modification); |
| | | void addModification(Modification modification); |
| | | |
| | | |
| | | |
| | |
| | | * @return The current entry, or <CODE>null</CODE> if it is not yet |
| | | * available. |
| | | */ |
| | | public Entry getOriginalEntry(); |
| | | Entry getOriginalEntry(); |
| | | |
| | | |
| | | |
| | |
| | | * @return The updated entry, or <CODE>null</CODE> if it is not yet |
| | | * available. |
| | | */ |
| | | public Entry getUpdatedEntry(); |
| | | Entry getUpdatedEntry(); |
| | | } |
| | | |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2014 ForgeRock AS |
| | | * Portions Copyright 2014-2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.types.operation; |
| | | |
| | |
| | | * @return The raw, unprocessed entry DN as included in the client |
| | | * request. |
| | | */ |
| | | public ByteString getRawEntryDN(); |
| | | ByteString getRawEntryDN(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The DN of the entry to modify. |
| | | */ |
| | | public DN getEntryDN(); |
| | | DN getEntryDN(); |
| | | |
| | | |
| | | |
| | |
| | | * @return The set of raw, unprocessed modifications as included |
| | | * in the client request. |
| | | */ |
| | | public List<RawModification> getRawModifications(); |
| | | List<RawModification> getRawModifications(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The set of modifications for this modify operation. |
| | | */ |
| | | public List<Modification> getModifications(); |
| | | List<Modification> getModifications(); |
| | | |
| | | |
| | | |
| | |
| | | * while applying the modification to |
| | | * the entry. |
| | | */ |
| | | public void addModification(Modification modification) |
| | | throws DirectoryException; |
| | | void addModification(Modification modification) throws DirectoryException; |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The current entry before any modifications are applied. |
| | | */ |
| | | public Entry getCurrentEntry(); |
| | | Entry getCurrentEntry(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The modified entry that is to be written to the backend. |
| | | */ |
| | | public Entry getModifiedEntry(); |
| | | Entry getModifiedEntry(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2011-2014 ForgeRock AS. |
| | | * Portions Copyright 2011-2015 ForgeRock AS. |
| | | */ |
| | | package org.opends.server.types.operation; |
| | | import java.util.List; |
| | |
| | | * @param control The control to add to the set of controls to |
| | | * include in the response to the client. |
| | | */ |
| | | public void addResponseControl(Control control); |
| | | void addResponseControl(Control control); |
| | | |
| | | |
| | | |
| | |
| | | * @param control The control to remove from the set of controls |
| | | * to include in the response to the client. |
| | | */ |
| | | public void removeResponseControl(Control control); |
| | | void removeResponseControl(Control control); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The error message for this operation. |
| | | */ |
| | | public LocalizableMessageBuilder getErrorMessage(); |
| | | LocalizableMessageBuilder getErrorMessage(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @param errorMessage The error message for this operation. |
| | | */ |
| | | public void setErrorMessage(LocalizableMessageBuilder errorMessage); |
| | | void setErrorMessage(LocalizableMessageBuilder errorMessage); |
| | | |
| | | |
| | | |
| | |
| | | * @param message The message to append to the error message |
| | | * buffer. |
| | | */ |
| | | public void appendErrorMessage(LocalizableMessage message); |
| | | void appendErrorMessage(LocalizableMessage message); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The authorization DN for this operation. |
| | | */ |
| | | public DN getAuthorizationDN(); |
| | | DN getAuthorizationDN(); |
| | | |
| | | |
| | | |
| | |
| | | * @return An unmodifiable list containing the additional log items for this |
| | | * operation. |
| | | */ |
| | | public List<AdditionalLogItem> getAdditionalLogItems(); |
| | | List<AdditionalLogItem> getAdditionalLogItems(); |
| | | |
| | | |
| | | |
| | |
| | | * @param item |
| | | * The additional log item for this operation. |
| | | */ |
| | | public void addAdditionalLogItem(AdditionalLogItem item); |
| | | void addAdditionalLogItem(AdditionalLogItem item); |
| | | } |
| | | |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2013-2014 ForgeRock AS. |
| | | * Portions Copyright 2013-2015 ForgeRock AS. |
| | | */ |
| | | package org.opends.server.types.operation; |
| | | |
| | |
| | | * @return The raw, unprocessed base DN as included in the request |
| | | * from the client. |
| | | */ |
| | | public ByteString getRawBaseDN(); |
| | | ByteString getRawBaseDN(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The base DN for this search operation. |
| | | */ |
| | | public DN getBaseDN(); |
| | | DN getBaseDN(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The scope for this search operation. |
| | | */ |
| | | public SearchScope getScope(); |
| | | SearchScope getScope(); |
| | | |
| | | |
| | | |
| | |
| | | * @return The alias dereferencing policy for this search |
| | | * operation. |
| | | */ |
| | | public DereferenceAliasesPolicy getDerefPolicy(); |
| | | DereferenceAliasesPolicy getDerefPolicy(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The size limit for this search operation. |
| | | */ |
| | | public int getSizeLimit(); |
| | | int getSizeLimit(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The time limit for this search operation. |
| | | */ |
| | | public int getTimeLimit(); |
| | | int getTimeLimit(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The typesOnly flag for this search operation. |
| | | */ |
| | | public boolean getTypesOnly(); |
| | | boolean getTypesOnly(); |
| | | |
| | | |
| | | |
| | |
| | | * @return The raw, unprocessed search filter as included in the |
| | | * request from the client. |
| | | */ |
| | | public RawFilter getRawFilter(); |
| | | RawFilter getRawFilter(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The filter for this search operation. |
| | | */ |
| | | public SearchFilter getFilter(); |
| | | SearchFilter getFilter(); |
| | | |
| | | |
| | | |
| | |
| | | * @return The set of requested attributes for this search |
| | | * operation. |
| | | */ |
| | | public Set<String> getAttributes(); |
| | | Set<String> getAttributes(); |
| | | |
| | | |
| | | |
| | |
| | | * (e.g., the size limit has been reached or the search has |
| | | * been abandoned). |
| | | */ |
| | | public boolean returnEntry(Entry entry, List<Control> controls); |
| | | boolean returnEntry(Entry entry, List<Control> controls); |
| | | |
| | | |
| | | |
| | |
| | | * (e.g., the size limit has been reached or the search has |
| | | * been abandoned). |
| | | */ |
| | | public boolean |
| | | returnReference(DN dn ,SearchResultReference reference); |
| | | boolean returnReference(DN dn ,SearchResultReference reference); |
| | | } |
| | | |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.types.operation; |
| | | |
| | |
| | | * @return The message ID of the operation that should be |
| | | * abandoned. |
| | | */ |
| | | public int getIDToAbandon(); |
| | | int getIDToAbandon(); |
| | | } |
| | | |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2014 ForgeRock AS |
| | | * Portions Copyright 2014-2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.types.operation; |
| | | |
| | |
| | | * |
| | | * @return The DN of the entry in a raw, unparsed form. |
| | | */ |
| | | public ByteString getRawEntryDN(); |
| | | ByteString getRawEntryDN(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @param rawEntryDN The raw entry DN for the entry to add. |
| | | */ |
| | | public void setRawEntryDN(ByteString rawEntryDN); |
| | | void setRawEntryDN(ByteString rawEntryDN); |
| | | |
| | | |
| | | |
| | |
| | | * @return The set of attributes in their raw, unparsed form as |
| | | * read from the client request. |
| | | */ |
| | | public List<RawAttribute> getRawAttributes(); |
| | | List<RawAttribute> getRawAttributes(); |
| | | |
| | | |
| | | |
| | |
| | | * @param rawAttribute The attribute to add to the set of raw |
| | | * attributes for this add operation. |
| | | */ |
| | | public void addRawAttribute(RawAttribute rawAttribute); |
| | | void addRawAttribute(RawAttribute rawAttribute); |
| | | |
| | | |
| | | |
| | |
| | | * @param rawAttributes The set of raw attributes for this add |
| | | * operation. |
| | | */ |
| | | public void setRawAttributes(List<RawAttribute> rawAttributes); |
| | | void setRawAttributes(List<RawAttribute> rawAttributes); |
| | | } |
| | | |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2014 ForgeRock AS |
| | | * Portions Copyright 2014-2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.types.operation; |
| | | import org.forgerock.i18n.LocalizableMessage; |
| | |
| | | * |
| | | * @return The authentication type for this bind operation. |
| | | */ |
| | | public AuthenticationType getAuthenticationType(); |
| | | AuthenticationType getAuthenticationType(); |
| | | |
| | | |
| | | |
| | |
| | | * @return A string representation of the protocol version |
| | | * associated with this bind request. |
| | | */ |
| | | public String getProtocolVersion(); |
| | | String getProtocolVersion(); |
| | | |
| | | |
| | | |
| | |
| | | * protocol version associated with this |
| | | * bind request. |
| | | */ |
| | | public void setProtocolVersion(String protocolVersion); |
| | | void setProtocolVersion(String protocolVersion); |
| | | |
| | | |
| | | |
| | |
| | | * @return The raw, unprocessed bind DN for this bind operation as |
| | | * contained in the client request. |
| | | */ |
| | | public ByteString getRawBindDN(); |
| | | ByteString getRawBindDN(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @param rawBindDN The raw, unprocessed bind DN for this bind |
| | | */ |
| | | public void setRawBindDN(ByteString rawBindDN); |
| | | void setRawBindDN(ByteString rawBindDN); |
| | | |
| | | |
| | | |
| | |
| | | * @return The simple authentication password for this bind |
| | | * operation. |
| | | */ |
| | | public ByteString getSimplePassword(); |
| | | ByteString getSimplePassword(); |
| | | |
| | | |
| | | |
| | |
| | | * @param simplePassword The simple authentication password for |
| | | * this bind operation. |
| | | */ |
| | | public void setSimplePassword(ByteString simplePassword); |
| | | void setSimplePassword(ByteString simplePassword); |
| | | |
| | | |
| | | |
| | |
| | | * <CODE>null</CODE> if the bind does not use SASL |
| | | * authentication. |
| | | */ |
| | | public String getSASLMechanism(); |
| | | String getSASLMechanism(); |
| | | |
| | | |
| | | |
| | |
| | | * <CODE>null</CODE> if there are none or if the bind does |
| | | * not use SASL authentication. |
| | | */ |
| | | public ByteString getSASLCredentials(); |
| | | ByteString getSASLCredentials(); |
| | | |
| | | |
| | | |
| | |
| | | * operation, or <CODE>null</CODE> if there |
| | | * are none. |
| | | */ |
| | | public void setSASLCredentials(String saslMechanism, |
| | | ByteString saslCredentials); |
| | | void setSASLCredentials(String saslMechanism, ByteString saslCredentials); |
| | | |
| | | |
| | | |
| | |
| | | * @param serverSASLCredentials The set of server SASL credentials |
| | | * to include in the bind response. |
| | | */ |
| | | public void setServerSASLCredentials(ByteString |
| | | serverSASLCredentials); |
| | | void setServerSASLCredentials(ByteString serverSASLCredentials); |
| | | |
| | | |
| | | |
| | |
| | | * @param reason A human-readable message providing the reason |
| | | * that the authentication failed. |
| | | */ |
| | | public void setAuthFailureReason(LocalizableMessage reason); |
| | | void setAuthFailureReason(LocalizableMessage reason); |
| | | } |
| | | |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2014 ForgeRock AS |
| | | * Portions Copyright 2014-2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.types.operation; |
| | | |
| | |
| | | * @return The raw, unprocessed entry DN as included in the client |
| | | * request. |
| | | */ |
| | | public ByteString getRawEntryDN(); |
| | | ByteString getRawEntryDN(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @param rawEntryDN The raw entry DN for this compare operation. |
| | | */ |
| | | public void setRawEntryDN(ByteString rawEntryDN); |
| | | void setRawEntryDN(ByteString rawEntryDN); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The raw attribute type for this compare operation. |
| | | */ |
| | | public String getRawAttributeType(); |
| | | String getRawAttributeType(); |
| | | |
| | | |
| | | |
| | |
| | | * @param rawAttributeType The raw attribute type for this compare |
| | | * operation. |
| | | */ |
| | | public void setRawAttributeType(String rawAttributeType); |
| | | void setRawAttributeType(String rawAttributeType); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The assertion value for this compare operation. |
| | | */ |
| | | public ByteString getAssertionValue(); |
| | | ByteString getAssertionValue(); |
| | | |
| | | |
| | | |
| | |
| | | * @param assertionValue The assertion value for this compare |
| | | * operation. |
| | | */ |
| | | public void setAssertionValue(ByteString assertionValue); |
| | | void setAssertionValue(ByteString assertionValue); |
| | | } |
| | | |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2014 ForgeRock AS |
| | | * Portions Copyright 2014-2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.types.operation; |
| | | |
| | |
| | | * @return The raw, unprocessed entry DN as included in the client |
| | | * request. |
| | | */ |
| | | public ByteString getRawEntryDN(); |
| | | ByteString getRawEntryDN(); |
| | | |
| | | |
| | | |
| | |
| | | * @param rawEntryDN The raw, unprocessed entry DN for this delete |
| | | * operation. |
| | | */ |
| | | public void setRawEntryDN(ByteString rawEntryDN); |
| | | void setRawEntryDN(ByteString rawEntryDN); |
| | | } |
| | | |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2014 ForgeRock AS |
| | | * Portions Copyright 2014-2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.types.operation; |
| | | |
| | |
| | | * @return The OID for the request associated with this extended |
| | | * operation. |
| | | */ |
| | | public String getRequestOID(); |
| | | String getRequestOID(); |
| | | |
| | | |
| | | |
| | |
| | | * @param requestOID The OID for the request associated with this |
| | | * extended operation. |
| | | */ |
| | | public void setRequestOID(String requestOID); |
| | | void setRequestOID(String requestOID); |
| | | |
| | | |
| | | |
| | |
| | | * @return The value for the request associated with this extended |
| | | * operation. |
| | | */ |
| | | public ByteString getRequestValue(); |
| | | ByteString getRequestValue(); |
| | | |
| | | |
| | | |
| | |
| | | * @param requestValue The value for the request associated with |
| | | * this extended operation. |
| | | */ |
| | | public void setRequestValue(ByteString requestValue); |
| | | void setRequestValue(ByteString requestValue); |
| | | |
| | | |
| | | |
| | |
| | | * @param responseOID The OID to include in the response to the |
| | | * client. |
| | | */ |
| | | public void setResponseOID(String responseOID); |
| | | void setResponseOID(String responseOID); |
| | | |
| | | |
| | | |
| | |
| | | * @param responseValue The value to include in the response to |
| | | * the client. |
| | | */ |
| | | public void setResponseValue(ByteString responseValue); |
| | | void setResponseValue(ByteString responseValue); |
| | | } |
| | | |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2014 ForgeRock AS |
| | | * Portions Copyright 2014-2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.types.operation; |
| | | |
| | |
| | | * @return The raw, unprocessed entry DN as included in the client |
| | | * request. |
| | | */ |
| | | public ByteString getRawEntryDN(); |
| | | ByteString getRawEntryDN(); |
| | | |
| | | |
| | | |
| | |
| | | * @param rawEntryDN The raw, unprocessed entry DN as included in |
| | | * the client request. |
| | | */ |
| | | public void setRawEntryDN(ByteString rawEntryDN); |
| | | void setRawEntryDN(ByteString rawEntryDN); |
| | | |
| | | |
| | | |
| | |
| | | * @return The raw, unprocessed newRDN as included in the request |
| | | * from the client. |
| | | */ |
| | | public ByteString getRawNewRDN(); |
| | | ByteString getRawNewRDN(); |
| | | |
| | | |
| | | |
| | |
| | | * @param rawNewRDN The raw, unprocessed newRDN as included in the |
| | | * request from the client. |
| | | */ |
| | | public void setRawNewRDN(ByteString rawNewRDN); |
| | | void setRawNewRDN(ByteString rawNewRDN); |
| | | |
| | | |
| | | |
| | |
| | | * @return <CODE>true</CODE> if the current RDN value should be |
| | | * removed from the entry, or <CODE>false</CODE> if not. |
| | | */ |
| | | public boolean deleteOldRDN(); |
| | | boolean deleteOldRDN(); |
| | | |
| | | |
| | | |
| | |
| | | * @param deleteOldRDN Specifies whether the current RDN value |
| | | * should be removed from the entry. |
| | | */ |
| | | public void setDeleteOldRDN(boolean deleteOldRDN); |
| | | void setDeleteOldRDN(boolean deleteOldRDN); |
| | | |
| | | |
| | | |
| | |
| | | * @return The raw, unprocessed newSuperior from the client |
| | | * request, or <CODE>null</CODE> if there is none. |
| | | */ |
| | | public ByteString getRawNewSuperior(); |
| | | ByteString getRawNewSuperior(); |
| | | |
| | | |
| | | |
| | |
| | | * @param rawNewSuperior The raw, unprocessed newSuperior as |
| | | * provided in the request from the client. |
| | | */ |
| | | public void setRawNewSuperior(ByteString rawNewSuperior); |
| | | void setRawNewSuperior(ByteString rawNewSuperior); |
| | | } |
| | | |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2014 ForgeRock AS |
| | | * Portions Copyright 2014-2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.types.operation; |
| | | |
| | |
| | | * @return The raw, unprocessed entry DN as included in the client |
| | | * request. |
| | | */ |
| | | public ByteString getRawEntryDN(); |
| | | ByteString getRawEntryDN(); |
| | | |
| | | |
| | | |
| | |
| | | * @param rawEntryDN The raw, unprocessed entry DN as included in |
| | | * the client request. |
| | | */ |
| | | public void setRawEntryDN(ByteString rawEntryDN); |
| | | void setRawEntryDN(ByteString rawEntryDN); |
| | | |
| | | |
| | | |
| | |
| | | * @return The set of raw, unprocessed modifications as included |
| | | * in the client request. |
| | | */ |
| | | public List<RawModification> getRawModifications(); |
| | | List<RawModification> getRawModifications(); |
| | | |
| | | |
| | | |
| | |
| | | * raw modifications for this modify |
| | | * operation. |
| | | */ |
| | | public void addRawModification(RawModification rawModification); |
| | | void addRawModification(RawModification rawModification); |
| | | |
| | | |
| | | |
| | |
| | | * @param rawModifications The raw modifications for this modify |
| | | * operation. |
| | | */ |
| | | public void setRawModifications( |
| | | List<RawModification> rawModifications); |
| | | void setRawModifications(List<RawModification> rawModifications); |
| | | } |
| | | |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2011-2014 ForgeRock AS. |
| | | * Portions Copyright 2011-2015 ForgeRock AS. |
| | | */ |
| | | package org.opends.server.types.operation; |
| | | |
| | |
| | | * @param control The control to add to the set of request |
| | | * controls for this operation. |
| | | */ |
| | | public void addRequestControl(Control control); |
| | | void addRequestControl(Control control); |
| | | |
| | | |
| | | |
| | |
| | | * @param control The control to add to the set of controls to |
| | | * include in the response to the client. |
| | | */ |
| | | public void addResponseControl(Control control); |
| | | void addResponseControl(Control control); |
| | | |
| | | |
| | | |
| | |
| | | * @param control The control to remove from the set of controls |
| | | * to include in the response to the client. |
| | | */ |
| | | public void removeResponseControl(Control control); |
| | | void removeResponseControl(Control control); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The error message for this operation. |
| | | */ |
| | | public LocalizableMessageBuilder getErrorMessage(); |
| | | LocalizableMessageBuilder getErrorMessage(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @param errorMessage The error message for this operation. |
| | | */ |
| | | public void setErrorMessage(LocalizableMessageBuilder errorMessage); |
| | | void setErrorMessage(LocalizableMessageBuilder errorMessage); |
| | | |
| | | |
| | | |
| | |
| | | * @param message The message to append to the error message |
| | | * buffer. |
| | | */ |
| | | public void appendErrorMessage(LocalizableMessage message); |
| | | void appendErrorMessage(LocalizableMessage message); |
| | | |
| | | |
| | | |
| | |
| | | * @return An unmodifiable list containing the additional log items for this |
| | | * operation. |
| | | */ |
| | | public List<AdditionalLogItem> getAdditionalLogItems(); |
| | | List<AdditionalLogItem> getAdditionalLogItems(); |
| | | |
| | | |
| | | |
| | |
| | | * @param item |
| | | * The additional log item for this operation. |
| | | */ |
| | | public void addAdditionalLogItem(AdditionalLogItem item); |
| | | void addAdditionalLogItem(AdditionalLogItem item); |
| | | } |
| | | |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2013-2014 ForgeRock AS. |
| | | * Portions Copyright 2013-2015 ForgeRock AS. |
| | | */ |
| | | package org.opends.server.types.operation; |
| | | |
| | |
| | | * @return The raw, unprocessed base DN as included in the request |
| | | * from the client. |
| | | */ |
| | | public ByteString getRawBaseDN(); |
| | | ByteString getRawBaseDN(); |
| | | |
| | | |
| | | |
| | |
| | | * @param rawBaseDN The raw, unprocessed base DN for this search |
| | | operation. |
| | | */ |
| | | public void setRawBaseDN(ByteString rawBaseDN); |
| | | void setRawBaseDN(ByteString rawBaseDN); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The scope for this search operation. |
| | | */ |
| | | public SearchScope getScope(); |
| | | SearchScope getScope(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @param scope The scope for this search operation. |
| | | */ |
| | | public void setScope(SearchScope scope); |
| | | void setScope(SearchScope scope); |
| | | |
| | | |
| | | |
| | |
| | | * @return The alias dereferencing policy for this search |
| | | * operation. |
| | | */ |
| | | public DereferenceAliasesPolicy getDerefPolicy(); |
| | | DereferenceAliasesPolicy getDerefPolicy(); |
| | | |
| | | |
| | | |
| | |
| | | * @param derefPolicy The alias dereferencing policy for this |
| | | * search operation. |
| | | */ |
| | | public void setDerefPolicy(DereferenceAliasesPolicy derefPolicy); |
| | | void setDerefPolicy(DereferenceAliasesPolicy derefPolicy); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The size limit for this search operation. |
| | | */ |
| | | public int getSizeLimit(); |
| | | int getSizeLimit(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @param sizeLimit The size limit for this search operation. |
| | | */ |
| | | public void setSizeLimit(int sizeLimit); |
| | | void setSizeLimit(int sizeLimit); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The time limit for this search operation. |
| | | */ |
| | | public int getTimeLimit(); |
| | | int getTimeLimit(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @param timeLimit The time limit for this search operation. |
| | | */ |
| | | public void setTimeLimit(int timeLimit); |
| | | void setTimeLimit(int timeLimit); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The typesOnly flag for this search operation. |
| | | */ |
| | | public boolean getTypesOnly(); |
| | | boolean getTypesOnly(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @param typesOnly The typesOnly flag for this search operation. |
| | | */ |
| | | public void setTypesOnly(boolean typesOnly); |
| | | void setTypesOnly(boolean typesOnly); |
| | | |
| | | |
| | | |
| | |
| | | * @return The raw, unprocessed search filter as included in the |
| | | * request from the client. |
| | | */ |
| | | public RawFilter getRawFilter(); |
| | | RawFilter getRawFilter(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @param rawFilter The raw, unprocessed search filter. |
| | | */ |
| | | public void setRawFilter(RawFilter rawFilter); |
| | | void setRawFilter(RawFilter rawFilter); |
| | | |
| | | |
| | | |
| | |
| | | * @return The set of requested attributes for this search |
| | | * operation. |
| | | */ |
| | | public Set<String> getAttributes(); |
| | | Set<String> getAttributes(); |
| | | |
| | | |
| | | |
| | |
| | | * @param attributes The set of requested attributes for this |
| | | * search operation. |
| | | */ |
| | | public void setAttributes(Set<String> attributes); |
| | | void setAttributes(Set<String> attributes); |
| | | |
| | | |
| | | |
| | |
| | | * (e.g., the size limit has been reached or the search has |
| | | * been abandoned). |
| | | */ |
| | | public boolean returnEntry(Entry entry, List<Control> controls); |
| | | boolean returnEntry(Entry entry, List<Control> controls); |
| | | |
| | | |
| | | |
| | |
| | | * Returns the provided search result reference to the client. |
| | | * |
| | | * @param reference The search reference that should be returned. |
| | | * @param dn A DN related to the specified search |
| | | * reference. |
| | | * |
| | | * @param dn A DN related to the specified search reference. |
| | | * @return {@code true} if the caller should continue processing |
| | | * the search request and sending additional entries and |
| | | * references, or {@code false} if not for some reason |
| | | * (e.g., the size limit has been reached or the search has |
| | | * been abandoned). |
| | | */ |
| | | public boolean |
| | | returnReference(DN dn, SearchResultReference reference); |
| | | boolean returnReference(DN dn, SearchResultReference reference); |
| | | } |
| | | |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2013-2014 ForgeRock AS. |
| | | * Portions Copyright 2013-2015 ForgeRock AS. |
| | | */ |
| | | package org.opends.server.types.operation; |
| | | |
| | |
| | | * @return The raw, unprocessed base DN as included in the request |
| | | * from the client. |
| | | */ |
| | | public ByteString getRawBaseDN(); |
| | | ByteString getRawBaseDN(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The base DN for this search operation. |
| | | */ |
| | | public DN getBaseDN(); |
| | | DN getBaseDN(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The scope for this search operation. |
| | | */ |
| | | public SearchScope getScope(); |
| | | SearchScope getScope(); |
| | | |
| | | |
| | | |
| | |
| | | * @return The alias dereferencing policy for this search |
| | | * operation. |
| | | */ |
| | | public DereferenceAliasesPolicy getDerefPolicy(); |
| | | DereferenceAliasesPolicy getDerefPolicy(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The size limit for this search operation. |
| | | */ |
| | | public int getSizeLimit(); |
| | | int getSizeLimit(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The time limit for this search operation. |
| | | */ |
| | | public int getTimeLimit(); |
| | | int getTimeLimit(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The typesOnly flag for this search operation. |
| | | */ |
| | | public boolean getTypesOnly(); |
| | | boolean getTypesOnly(); |
| | | |
| | | |
| | | |
| | |
| | | * @return The raw, unprocessed search filter as included in the |
| | | * request from the client. |
| | | */ |
| | | public RawFilter getRawFilter(); |
| | | RawFilter getRawFilter(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The filter for this search operation. |
| | | */ |
| | | public SearchFilter getFilter(); |
| | | SearchFilter getFilter(); |
| | | |
| | | |
| | | |
| | |
| | | * @return The set of requested attributes for this search |
| | | * operation. |
| | | */ |
| | | public Set<String> getAttributes(); |
| | | Set<String> getAttributes(); |
| | | } |
| | | |
| | |
| | | * |
| | | * |
| | | * Copyright 2006-2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2013-2014 ForgeRock AS. |
| | | * Portions Copyright 2013-2015 ForgeRock AS. |
| | | */ |
| | | package org.opends.server.types.operation; |
| | | |
| | |
| | | * @return The raw, unprocessed base DN as included in the request |
| | | * from the client. |
| | | */ |
| | | public ByteString getRawBaseDN(); |
| | | ByteString getRawBaseDN(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The base DN for this search operation. |
| | | */ |
| | | public DN getBaseDN(); |
| | | DN getBaseDN(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The scope for this search operation. |
| | | */ |
| | | public SearchScope getScope(); |
| | | SearchScope getScope(); |
| | | |
| | | |
| | | |
| | |
| | | * @return The alias dereferencing policy for this search |
| | | * operation. |
| | | */ |
| | | public DereferenceAliasesPolicy getDerefPolicy(); |
| | | DereferenceAliasesPolicy getDerefPolicy(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The size limit for this search operation. |
| | | */ |
| | | public int getSizeLimit(); |
| | | int getSizeLimit(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The time limit for this search operation. |
| | | */ |
| | | public int getTimeLimit(); |
| | | int getTimeLimit(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The typesOnly flag for this search operation. |
| | | */ |
| | | public boolean getTypesOnly(); |
| | | boolean getTypesOnly(); |
| | | |
| | | |
| | | |
| | |
| | | * @return The raw, unprocessed search filter as included in the |
| | | * request from the client. |
| | | */ |
| | | public RawFilter getRawFilter(); |
| | | RawFilter getRawFilter(); |
| | | |
| | | |
| | | |
| | |
| | | * |
| | | * @return The filter for this search operation. |
| | | */ |
| | | public SearchFilter getFilter(); |
| | | SearchFilter getFilter(); |
| | | |
| | | |
| | | |
| | |
| | | * @return The set of requested attributes for this search |
| | | * operation. |
| | | */ |
| | | public Set<String> getAttributes(); |
| | | Set<String> getAttributes(); |
| | | } |
| | | |
| | |
| | | * |
| | | * |
| | | * Copyright 2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2014 ForgeRock AS |
| | | * Portions Copyright 2014-2015 ForgeRock AS |
| | | */ |
| | | package org.opends.server.types.operation; |
| | | |
| | |
| | | * @return The raw, unprocessed entry DN as included in the client |
| | | * request. |
| | | */ |
| | | public ByteString getRawEntryDN(); |
| | | ByteString getRawEntryDN(); |
| | | |
| | | |
| | | |
| | |
| | | * @return The DN of the entry to rename, or {@code null} if the |
| | | * raw entry DN has not yet been processed. |
| | | */ |
| | | public DN getEntryDN(); |
| | | DN getEntryDN(); |
| | | |
| | | |
| | | |
| | |
| | | * @return The raw, unprocessed newRDN as included in the request |
| | | * from the client. |
| | | */ |
| | | public ByteString getRawNewRDN(); |
| | | ByteString getRawNewRDN(); |
| | | |
| | | |
| | | |
| | |
| | | * @return The new RDN to use for the entry, or {@code null} if the |
| | | * raw newRDN has not yet been processed. |
| | | */ |
| | | public RDN getNewRDN(); |
| | | RDN getNewRDN(); |
| | | |
| | | |
| | | |
| | |
| | | * @return {@code true} if the current RDN value should be removed |
| | | * from the entry, or {@code false} if not. |
| | | */ |
| | | public boolean deleteOldRDN(); |
| | | boolean deleteOldRDN(); |
| | | |
| | | |
| | | |
| | |
| | | * @return The raw, unprocessed newSuperior from the client |
| | | * request, or {@code null} if there is none. |
| | | */ |
| | | public ByteString getRawNewSuperior(); |
| | | ByteString getRawNewSuperior(); |
| | | |
| | | |
| | | |
| | |
| | | * there is no newSuperior DN for this request or if the |
| | | * raw newSuperior has not yet been processed. |
| | | */ |
| | | public DN getNewSuperior(); |
| | | DN getNewSuperior(); |
| | | |
| | | |
| | | |
| | |
| | | * @return The current entry, or {@code null} if it is not yet |
| | | * available. |
| | | */ |
| | | public Entry getOriginalEntry(); |
| | | Entry getOriginalEntry(); |
| | | |
| | | |
| | | |
| | |
| | | * @return The updated entry, or {@code null} if it is not yet |
| | | * available. |
| | | */ |
| | | public Entry getUpdatedEntry(); |
| | | Entry getUpdatedEntry(); |
| | | } |
| | | |
| | |
| | | * CDDL HEADER END |
| | | * |
| | | * |
| | | * Portions Copyright 2010-2014 ForgeRock AS |
| | | * Portions Copyright 2010-2015 ForgeRock AS |
| | | * |
| | | * BSD-compatible md5 password crypt |
| | | * Ported to Java from C based on crypt-md5.c by Poul-Henning Kamp, |
| | |
| | | */ |
| | | public final class BSDMD5Crypt { |
| | | |
| | | private final static String magic = "$1$"; |
| | | private final static int saltLength = 8; |
| | | private final static String itoa64 = |
| | | private static final String magic = "$1$"; |
| | | private static final int saltLength = 8; |
| | | private static final String itoa64 = |
| | | "./0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz"; |
| | | |
| | | private static String intTo64(int value, int length) |
| | |
| | | * @throws NoSuchAlgorithmException If the MD5 algorithm is not supported. |
| | | * |
| | | */ |
| | | static public String crypt(ByteSequence password) |
| | | public static String crypt(ByteSequence password) |
| | | throws NoSuchAlgorithmException |
| | | { |
| | | SecureRandom randomGenerator = new SecureRandom(); |
| | |
| | | * @throws NoSuchAlgorithmException If the MD5 algorithm is not supported. |
| | | * |
| | | */ |
| | | static public String crypt(ByteSequence password, String salt) |
| | | public static String crypt(ByteSequence password, String salt) |
| | | throws NoSuchAlgorithmException |
| | | { |
| | | MessageDigest ctx, ctx1; |
| | |
| | | * |
| | | * @return the magic string for this crypt algorithm |
| | | */ |
| | | static public String getMagicString() |
| | | public static String getMagicString() |
| | | { |
| | | return magic; |
| | | } |
| | |
| | | * @param argv The array of test arguments |
| | | * |
| | | */ |
| | | static public void main(String argv[]) |
| | | public static void main(String argv[]) |
| | | { |
| | | if ((argv.length < 1) || (argv.length > 2)) |
| | | { |
| | |
| | | * |
| | | * |
| | | * Copyright 2009-2010 Sun Microsystems, Inc. |
| | | * Portions Copyright 2013-2014 ForgeRock AS. |
| | | * Portions Copyright 2013-2015 ForgeRock AS. |
| | | */ |
| | | |
| | | package org.opends.server.util; |
| | |
| | | /** |
| | | * Platform base class. Performs all of the certificate management functions. |
| | | */ |
| | | private abstract static class PlatformIMPL |
| | | private static abstract class PlatformIMPL |
| | | { |
| | | |
| | | // Key size, key algorithm and signature algorithms used. |
| | |
| | | * indicates that the file is in use by this or another |
| | | * application. |
| | | */ |
| | | static public void renameFile(File fileToRename, File target) |
| | | public static void renameFile(File fileToRename, File target) |
| | | throws IOException { |
| | | if (fileToRename != null && target != null) |
| | | { |
| | |
| | | * @throws ParseException if there was a problem converting the string to |
| | | * a <code>Date</code>. |
| | | */ |
| | | static public Date parseDateTimeString(String timeStr) throws ParseException |
| | | public static Date parseDateTimeString(String timeStr) throws ParseException |
| | | { |
| | | Date dateTime = null; |
| | | if (timeStr != null) |
| | |
| | | * @param date to format; null if <code>date</code> is null |
| | | * @return string representation of the date |
| | | */ |
| | | static public String formatDateTimeString(Date date) |
| | | public static String formatDateTimeString(Date date) |
| | | { |
| | | String timeStr = null; |
| | | if (date != null) |
| | |
| | | /** |
| | | * Container for registered issues. |
| | | */ |
| | | static private final Set<VersionCompatibilityIssue> |
| | | private static final Set<VersionCompatibilityIssue> |
| | | VERSION_COMPATIBILITY_ISSUES = |
| | | new HashSet<VersionCompatibilityIssue>(); |
| | | |
| | |
| | | register(Cause.BERKLEY_UPGRADE_1, new BuildVersion(0, 1, 0, 890)); |
| | | } |
| | | |
| | | static private void register(Cause cause, |
| | | private static void register(Cause cause, |
| | | BuildVersion version) { |
| | | VERSION_COMPATIBILITY_ISSUES.add(new VersionCompatibilityIssue(cause, |
| | | version)); |
| | |
| | | * @return list of issues sorted by build version in which |
| | | * they appear |
| | | */ |
| | | static public List<VersionCompatibilityIssue> getAllEvents() { |
| | | public static List<VersionCompatibilityIssue> getAllEvents() { |
| | | List<VersionCompatibilityIssue> issueList = |
| | | new ArrayList<VersionCompatibilityIssue> |
| | | (VERSION_COMPATIBILITY_ISSUES); |
| | |
| | | * @return list of issues sorted by build version in which |
| | | * they appear |
| | | */ |
| | | static public List<VersionCompatibilityIssue> getEvents( |
| | | public static List<VersionCompatibilityIssue> getEvents( |
| | | Collection<Integer> excludeIds, BuildInformation current, |
| | | BuildInformation neu) |
| | | { |
| | |
| | | * @param from build from which events will be returned |
| | | * @return List or IncompatibleVersionEvent objects |
| | | */ |
| | | static public List<VersionCompatibilityIssue> getEvents(BuildVersion from) { |
| | | public static List<VersionCompatibilityIssue> getEvents(BuildVersion from) { |
| | | List<VersionCompatibilityIssue> issueList = |
| | | new ArrayList<VersionCompatibilityIssue>(); |
| | | for (VersionCompatibilityIssue evt : VERSION_COMPATIBILITY_ISSUES) { |
| | |
| | | * Comparator used to sort issues by the build version for |
| | | * which they apply. |
| | | */ |
| | | static private final Comparator<VersionCompatibilityIssue> |
| | | private static final Comparator<VersionCompatibilityIssue> |
| | | VERSION_COMPARATOR = new Comparator<VersionCompatibilityIssue>() |
| | | { |
| | | @Override |
| | |
| | | * |
| | | * |
| | | * Copyright 2007-2009 Sun Microsystems, Inc. |
| | | * Portions copyright 2011-2012 ForgeRock AS. |
| | | * Portions Copyright 2011-2015 ForgeRock AS. |
| | | */ |
| | | |
| | | package org.opends.messages; |
| | |
| | | */ |
| | | USER_DEFINED(0x7FF00000); |
| | | |
| | | static private Map<Integer,Category> MASK_VALUE_MAP; |
| | | private static Map<Integer,Category> MASK_VALUE_MAP; |
| | | |
| | | static { |
| | | MASK_VALUE_MAP = new HashMap<Integer,Category>(); |
| | |
| | | * Obtains the <code>Severity</code> associated with the the input |
| | | * message ID <code>msgId</code>. |
| | | * @param msgId int message ID |
| | | * @return Severity assocated with the ID |
| | | * @return Severity associated with the ID |
| | | */ |
| | | static public Category parseMessageId(int msgId) { |
| | | public static Category parseMessageId(int msgId) { |
| | | return Category.parseMask(msgId & 0xFFF00000); |
| | | } |
| | | |
| | |
| | | * @param mask for which a <code>Severity</code> is obtained. |
| | | * @return Severity associated with <code>mask</code> |
| | | */ |
| | | static public Category parseMask(int mask) { |
| | | public static Category parseMask(int mask) { |
| | | return MASK_VALUE_MAP.get(mask); |
| | | } |
| | | |
| | |
| | | * |
| | | * |
| | | * Copyright 2008 Sun Microsystems, Inc. |
| | | * Portions Copyright 2014 ForgeRock AS |
| | | * Portions Copyright 2014-2015 ForgeRock AS |
| | | */ |
| | | |
| | | package org.opends.messages; |
| | |
| | | */ |
| | | NOTICE("NOTE"); |
| | | |
| | | static private Set<String> PROPERTY_KEY_FORM_VALUES_SET; |
| | | private static Set<String> PROPERTY_KEY_FORM_VALUES_SET; |
| | | |
| | | static private Map<String,Severity> PROPERTY_KEY_FORM_MAP; |
| | | private static Map<String,Severity> PROPERTY_KEY_FORM_MAP; |
| | | |
| | | static { |
| | | PROPERTY_KEY_FORM_MAP = new HashMap<String,Severity>(); |
| | |
| | | * abbreviated representations. |
| | | * @return set of messageDescriptorForm strings |
| | | */ |
| | | static public Set<String> getPropertyKeyFormSet() { |
| | | public static Set<String> getPropertyKeyFormSet() { |
| | | return Collections.unmodifiableSet(PROPERTY_KEY_FORM_VALUES_SET); |
| | | } |
| | | |
| | |
| | | * string <code>s</code> which can either be a severity's name |
| | | * or messageDescriptorForm. |
| | | * @param s Severity name or messageDescriptorForm |
| | | * @return Severity assocated with <code>s</code> |
| | | * @return Severity associated with <code>s</code> |
| | | */ |
| | | static public Severity parseString(String s) { |
| | | public static Severity parseString(String s) { |
| | | Severity sev = PROPERTY_KEY_FORM_MAP.get(s); |
| | | if (sev == null) { |
| | | sev = valueOf(s); |