You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@directory.apache.org by se...@apache.org on 2010/09/27 08:15:32 UTC
svn commit: r1001595 - in
/directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2:
./ engine/ reponse/ request/
Author: seelmann
Date: Mon Sep 27 06:15:30 2010
New Revision: 1001595
URL: http://svn.apache.org/viewvc?rev=1001595&view=rev
Log:
Fixed checkstyle errors and formatting
Modified:
directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/AbstractGrammar.java
directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/Container.java
directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/DsmlDecorator.java
directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/Dsmlv2Container.java
directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/Dsmlv2Parser.java
directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/Dsmlv2ResponseParser.java
directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/Dsmlv2StatesEnum.java
directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/GrammarAction.java
directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/IAction.java
directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/IGrammar.java
directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/IStates.java
directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/LdapMessageDecorator.java
directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/ParserUtils.java
directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/engine/Dsmlv2Engine.java
directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/AbstractResponseDsml.java
directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/AddResponseDsml.java
directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/AuthResponseDsml.java
directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/BatchResponseDsml.java
directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/CompareResponseDsml.java
directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/DelResponseDsml.java
directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/Dsmlv2ResponseGrammar.java
directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/ErrorResponse.java
directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/ExtendedResponseDsml.java
directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/LdapResponseDecorator.java
directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/LdapResultDsml.java
directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/LdapResultEnum.java
directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/ModDNResponseDsml.java
directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/ModifyResponseDsml.java
directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/SearchResponse.java
directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/SearchResponseDsml.java
directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/SearchResultDoneDsml.java
directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/SearchResultEntryDsml.java
directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/SearchResultReferenceDsml.java
directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/request/AbstractRequestDsml.java
directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/request/BatchRequest.java
directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/request/BatchRequestDsml.java
directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/request/Dsmlv2Grammar.java
directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/request/LdapRequestDecorator.java
directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/request/SearchRequestDsml.java
Modified: directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/AbstractGrammar.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/AbstractGrammar.java?rev=1001595&r1=1001594&r2=1001595&view=diff
==============================================================================
--- directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/AbstractGrammar.java (original)
+++ directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/AbstractGrammar.java Mon Sep 27 06:15:30 2010
@@ -114,8 +114,8 @@ public abstract class AbstractGrammar im
}
- /* (non-Javadoc)
- * @see org.apache.directory.shared.dsmlv2.IGrammar#executeAction(org.apache.directory.shared.dsmlv2.Dsmlv2Container)
+ /**
+ * {@inheritDoc}
*/
public void executeAction( Dsmlv2Container container ) throws XmlPullParserException, IOException
{
Modified: directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/Container.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/Container.java?rev=1001595&r1=1001594&r2=1001595&view=diff
==============================================================================
--- directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/Container.java (original)
+++ directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/Container.java Mon Sep 27 06:15:30 2010
@@ -50,7 +50,7 @@ public interface Container
*
* @return Returns the transition from the previous state to the new state
*/
- public int getTransition();
+ int getTransition();
/**
@@ -59,12 +59,12 @@ public interface Container
* @param transition
* The transition to set
*/
- public void setTransition( int transition );
+ void setTransition( int transition );
/**
* @return Returns the states.
*/
- public IStates getStates();
+ IStates getStates();
}
Modified: directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/DsmlDecorator.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/DsmlDecorator.java?rev=1001595&r1=1001594&r2=1001595&view=diff
==============================================================================
--- directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/DsmlDecorator.java (original)
+++ directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/DsmlDecorator.java Mon Sep 27 06:15:30 2010
@@ -39,5 +39,5 @@ public interface DsmlDecorator
* @return
* the dom4j Element corresponding to the entry.
*/
- public Element toDsml( Element root );
+ Element toDsml( Element root );
}
Modified: directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/Dsmlv2Container.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/Dsmlv2Container.java?rev=1001595&r1=1001594&r2=1001595&view=diff
==============================================================================
--- directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/Dsmlv2Container.java (original)
+++ directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/Dsmlv2Container.java Mon Sep 27 06:15:30 2010
@@ -217,15 +217,15 @@ public class Dsmlv2Container implements
/**
* Get the transition associated with the state and tag
*
- * @param state
+ * @param currentState
* the current state
- * @param tag
+ * @param currentTag
* the current tag
* @return
* a valid transition if any, or null.
*/
- public GrammarTransition getTransition( int state, Tag tag )
+ public GrammarTransition getTransition( int currentState, Tag currentTag )
{
- return grammar.getTransition( state, tag );
+ return grammar.getTransition( currentState, currentTag );
}
}
Modified: directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/Dsmlv2Parser.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/Dsmlv2Parser.java?rev=1001595&r1=1001594&r2=1001595&view=diff
==============================================================================
--- directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/Dsmlv2Parser.java (original)
+++ directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/Dsmlv2Parser.java Mon Sep 27 06:15:30 2010
@@ -122,6 +122,7 @@ public class Dsmlv2Parser
* @throws XmlPullParserException
* when an unrecoverable error occurs
* @throws IOException
+ * when an IO execption occurs
*/
public void parse() throws XmlPullParserException, IOException
{
@@ -183,7 +184,7 @@ public class Dsmlv2Parser
* @throws XmlPullParserException
* when an error occurs during the parsing
*/
- private void processTag( Dsmlv2Container container, int tagType ) throws XmlPullParserException
+ private static void processTag( Dsmlv2Container container, int tagType ) throws XmlPullParserException
{
XmlPullParser xpp = container.getParser();
Modified: directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/Dsmlv2ResponseParser.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/Dsmlv2ResponseParser.java?rev=1001595&r1=1001594&r2=1001595&view=diff
==============================================================================
--- directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/Dsmlv2ResponseParser.java (original)
+++ directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/Dsmlv2ResponseParser.java Mon Sep 27 06:15:30 2010
@@ -77,7 +77,7 @@ public class Dsmlv2ResponseParser
* @throws XmlPullParserException
* if an error occurs in the parser
*/
- public void setInput( String str ) throws FileNotFoundException, XmlPullParserException
+ public void setInput( String str ) throws XmlPullParserException
{
container.getParser().setInput( new StringReader( str ) );
}
@@ -122,6 +122,7 @@ public class Dsmlv2ResponseParser
* @throws XmlPullParserException
* when an unrecoverable error occurs
* @throws IOException
+ * when an IO exception occurs
*/
public void parse() throws XmlPullParserException, IOException
{
@@ -183,7 +184,7 @@ public class Dsmlv2ResponseParser
* @throws XmlPullParserException
* when an error occurs during the parsing
*/
- private void processTag( Dsmlv2Container container, int tagType ) throws XmlPullParserException
+ private static void processTag( Dsmlv2Container container, int tagType ) throws XmlPullParserException
{
XmlPullParser xpp = container.getParser();
Modified: directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/Dsmlv2StatesEnum.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/Dsmlv2StatesEnum.java?rev=1001595&r1=1001594&r2=1001595&view=diff
==============================================================================
--- directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/Dsmlv2StatesEnum.java (original)
+++ directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/Dsmlv2StatesEnum.java Mon Sep 27 06:15:30 2010
@@ -23,11 +23,13 @@ package org.apache.directory.shared.dsml
/**
* This class store the Dsml grammar's constants. It is also used for debugging
- * purpose
+ * purpose.
+ *
+ * TODO: Should this class be an enum?
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
-public class Dsmlv2StatesEnum implements IStates
+public final class Dsmlv2StatesEnum implements IStates
{
//====================================================
// <batchRequest> ... </batchRequest>
@@ -508,7 +510,12 @@ public class Dsmlv2StatesEnum implements
}
- /** Get the current state for a specified grammar */
+ /**
+ * Get the current state for a specified grammar.
+ *
+ * @param state the state
+ * @return the state
+ */
public String getState( int state )
{
switch ( state )
Modified: directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/GrammarAction.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/GrammarAction.java?rev=1001595&r1=1001594&r2=1001595&view=diff
==============================================================================
--- directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/GrammarAction.java (original)
+++ directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/GrammarAction.java Mon Sep 27 06:15:30 2010
@@ -30,7 +30,7 @@ package org.apache.directory.shared.dsml
public abstract class GrammarAction implements IAction
{
/** The action's name */
- protected String name;
+ private String name;
/**
Modified: directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/IAction.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/IAction.java?rev=1001595&r1=1001594&r2=1001595&view=diff
==============================================================================
--- directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/IAction.java (original)
+++ directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/IAction.java Mon Sep 27 06:15:30 2010
@@ -43,5 +43,5 @@ public interface IAction
* @throws XmlPullParserException
* thrown if something went wrong.
*/
- public void action( Dsmlv2Container container ) throws XmlPullParserException;
+ void action( Dsmlv2Container container ) throws XmlPullParserException;
}
\ No newline at end of file
Modified: directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/IGrammar.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/IGrammar.java?rev=1001595&r1=1001594&r2=1001595&view=diff
==============================================================================
--- directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/IGrammar.java (original)
+++ directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/IGrammar.java Mon Sep 27 06:15:30 2010
@@ -27,7 +27,7 @@ import org.xmlpull.v1.XmlPullParserExcep
/**
- * The interface which expose common behavior of a Gramar implementer.
+ * The interface which expose common behavior of a Grammar implementer.
*/
public interface IGrammar
{
@@ -35,14 +35,13 @@ public interface IGrammar
// ------------------------------------------------------------------------------------
/**
- * This method, when called, execute an action on the current data stored in
+ * This method, when called, executes an action on the current data stored in
* the container.
*
* @param container
* the DSML container
- * @throws XmlPullParserException
- * Thrown when an unrecoverable error occurs.
- * @throws IOException
+ * @throws XmlPullParserException when an unrecoverable error occurs
+ * @throws IOException when an IO error occurs
*/
void executeAction( Dsmlv2Container container ) throws XmlPullParserException, IOException;
Modified: directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/IStates.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/IStates.java?rev=1001595&r1=1001594&r2=1001595&view=diff
==============================================================================
--- directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/IStates.java (original)
+++ directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/IStates.java Mon Sep 27 06:15:30 2010
@@ -29,13 +29,13 @@ package org.apache.directory.shared.dsml
public interface IStates
{
/** The initial state of every grammar */
- static int INIT_GRAMMAR_STATE = 0;
+ int INIT_GRAMMAR_STATE = 0;
/** The ending state for every grammars */
- static int GRAMMAR_END = -1;
+ int GRAMMAR_END = -1;
/** The END_STATE */
- static int END_STATE = -1;
+ int END_STATE = -1;
/**
Modified: directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/LdapMessageDecorator.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/LdapMessageDecorator.java?rev=1001595&r1=1001594&r2=1001595&view=diff
==============================================================================
--- directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/LdapMessageDecorator.java (original)
+++ directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/LdapMessageDecorator.java Mon Sep 27 06:15:30 2010
@@ -72,8 +72,8 @@ public abstract class LdapMessageDecorat
}
- /* (non-Javadoc)
- * @see org.apache.directory.shared.ldap.codec.LdapMessageCodec#addControl(org.apache.directory.shared.ldap.codec.Control)
+ /**
+ * {@inheritDoc}
*/
public void addControl( Control control )
{
@@ -81,8 +81,8 @@ public abstract class LdapMessageDecorat
}
- /* (non-Javadoc)
- * @see org.apache.directory.shared.ldap.codec.LdapMessageCodec#getAbandonRequest()
+ /**
+ * {@inheritDoc}
*/
public AbandonRequest getAbandonRequest()
{
@@ -90,8 +90,8 @@ public abstract class LdapMessageDecorat
}
- /* (non-Javadoc)
- * @see org.apache.directory.shared.ldap.codec.LdapMessageCodec#getAddRequest()
+ /**
+ * {@inheritDoc}
*/
public AddRequest getAddRequest()
{
@@ -99,8 +99,8 @@ public abstract class LdapMessageDecorat
}
- /* (non-Javadoc)
- * @see org.apache.directory.shared.ldap.codec.LdapMessageCodec#getAddResponse()
+ /**
+ * {@inheritDoc}
*/
public AddResponse getAddResponse()
{
@@ -108,8 +108,8 @@ public abstract class LdapMessageDecorat
}
- /* (non-Javadoc)
- * @see org.apache.directory.shared.ldap.codec.LdapMessageCodec#getBindRequest()
+ /**
+ * {@inheritDoc}
*/
public BindRequest getBindRequest()
{
@@ -117,8 +117,8 @@ public abstract class LdapMessageDecorat
}
- /* (non-Javadoc)
- * @see org.apache.directory.shared.ldap.codec.LdapMessageCodec#getBindResponse()
+ /**
+ * {@inheritDoc}
*/
public BindResponse getBindResponse()
{
@@ -126,8 +126,8 @@ public abstract class LdapMessageDecorat
}
- /* (non-Javadoc)
- * @see org.apache.directory.shared.ldap.codec.LdapMessageCodec#getCompareRequest()
+ /**
+ * {@inheritDoc}
*/
public CompareRequest getCompareRequest()
{
@@ -135,8 +135,8 @@ public abstract class LdapMessageDecorat
}
- /* (non-Javadoc)
- * @see org.apache.directory.shared.ldap.codec.LdapMessageCodec#getCompareResponse()
+ /**
+ * {@inheritDoc}
*/
public CompareResponse getCompareResponse()
{
@@ -144,8 +144,8 @@ public abstract class LdapMessageDecorat
}
- /* (non-Javadoc)
- * @see org.apache.directory.shared.ldap.codec.LdapMessageCodec#getControls()
+ /**
+ * {@inheritDoc}
*/
public Map<String, Control> getControls()
{
@@ -153,8 +153,8 @@ public abstract class LdapMessageDecorat
}
- /* (non-Javadoc)
- * @see org.apache.directory.shared.ldap.codec.LdapMessageCodec#getControls(int)
+ /**
+ * {@inheritDoc}
*/
public Control getControl( String oid )
{
@@ -162,8 +162,8 @@ public abstract class LdapMessageDecorat
}
- /* (non-Javadoc)
- * @see org.apache.directory.shared.ldap.codec.LdapMessageCodec#getDelRequest()
+ /**
+ * {@inheritDoc}
*/
public DeleteRequest getDelRequest()
{
@@ -171,8 +171,8 @@ public abstract class LdapMessageDecorat
}
- /* (non-Javadoc)
- * @see org.apache.directory.shared.ldap.codec.LdapMessageCodec#getDelResponse()
+ /**
+ * {@inheritDoc}
*/
public DeleteResponse getDelResponse()
{
@@ -180,8 +180,8 @@ public abstract class LdapMessageDecorat
}
- /* (non-Javadoc)
- * @see org.apache.directory.shared.ldap.codec.LdapMessageCodec#getExtendedRequest()
+ /**
+ * {@inheritDoc}
*/
public ExtendedRequest getExtendedRequest()
{
@@ -189,8 +189,8 @@ public abstract class LdapMessageDecorat
}
- /* (non-Javadoc)
- * @see org.apache.directory.shared.ldap.codec.LdapMessageCodec#getExtendedResponse()
+ /**
+ * {@inheritDoc}
*/
public ExtendedResponse getExtendedResponse()
{
@@ -198,8 +198,8 @@ public abstract class LdapMessageDecorat
}
- /* (non-Javadoc)
- * @see org.apache.directory.shared.ldap.codec.LdapMessageCodec#getLdapResponse()
+ /**
+ * {@inheritDoc}
*/
public Response getLdapResponse()
{
@@ -207,8 +207,8 @@ public abstract class LdapMessageDecorat
}
- /* (non-Javadoc)
- * @see org.apache.directory.shared.ldap.codec.LdapMessageCodec#getMessageId()
+ /**
+ * {@inheritDoc}
*/
public int getMessageId()
{
@@ -216,8 +216,8 @@ public abstract class LdapMessageDecorat
}
- /* (non-Javadoc)
- * @see org.apache.directory.shared.ldap.codec.LdapMessageCodec#getType()
+ /**
+ * {@inheritDoc}
*/
public MessageTypeEnum getType()
{
@@ -225,8 +225,8 @@ public abstract class LdapMessageDecorat
}
- /* (non-Javadoc)
- * @see org.apache.directory.shared.ldap.codec.LdapMessageCodec#getModifyDNRequest()
+ /**
+ * {@inheritDoc}
*/
public ModifyDnRequest getModifyDNRequest()
{
@@ -234,8 +234,8 @@ public abstract class LdapMessageDecorat
}
- /* (non-Javadoc)
- * @see org.apache.directory.shared.ldap.codec.LdapMessageCodec#getModifyDNResponse()
+ /**
+ * {@inheritDoc}
*/
public ModifyDnResponse getModifyDNResponse()
{
@@ -243,8 +243,8 @@ public abstract class LdapMessageDecorat
}
- /* (non-Javadoc)
- * @see org.apache.directory.shared.ldap.codec.LdapMessageCodec#getModifyRequest()
+ /**
+ * {@inheritDoc}
*/
public ModifyRequest getModifyRequest()
{
@@ -252,8 +252,8 @@ public abstract class LdapMessageDecorat
}
- /* (non-Javadoc)
- * @see org.apache.directory.shared.ldap.codec.LdapMessageCodec#getModifyResponse()
+ /**
+ * {@inheritDoc}
*/
public ModifyResponse getModifyResponse()
{
@@ -261,8 +261,8 @@ public abstract class LdapMessageDecorat
}
- /* (non-Javadoc)
- * @see org.apache.directory.shared.ldap.codec.LdapMessageCodec#getSearchRequest()
+ /**
+ * {@inheritDoc}
*/
public SearchRequest getSearchRequest()
{
@@ -270,8 +270,8 @@ public abstract class LdapMessageDecorat
}
- /* (non-Javadoc)
- * @see org.apache.directory.shared.ldap.codec.LdapMessageCodec#getSearchResultDone()
+ /**
+ * {@inheritDoc}
*/
public SearchResultDone getSearchResultDone()
{
@@ -279,8 +279,8 @@ public abstract class LdapMessageDecorat
}
- /* (non-Javadoc)
- * @see org.apache.directory.shared.ldap.codec.LdapMessageCodec#getSearchResultEntry()
+ /**
+ * {@inheritDoc}
*/
public SearchResultEntry getSearchResultEntry()
{
@@ -288,8 +288,8 @@ public abstract class LdapMessageDecorat
}
- /* (non-Javadoc)
- * @see org.apache.directory.shared.ldap.codec.LdapMessageCodec#getSearchResultReference()
+ /**
+ * {@inheritDoc}
*/
public SearchResultReference getSearchResultReference()
{
@@ -297,8 +297,8 @@ public abstract class LdapMessageDecorat
}
- /* (non-Javadoc)
- * @see org.apache.directory.shared.ldap.codec.LdapMessageCodec#getUnBindRequest()
+ /**
+ * {@inheritDoc}
*/
public UnbindRequest getUnBindRequest()
{
@@ -306,8 +306,8 @@ public abstract class LdapMessageDecorat
}
- /* (non-Javadoc)
- * @see org.apache.directory.shared.ldap.codec.LdapMessageCodec#setMessageId(int)
+ /**
+ * {@inheritDoc}
*/
public void setMessageId( int messageId )
{
@@ -315,8 +315,8 @@ public abstract class LdapMessageDecorat
}
- /* (non-Javadoc)
- * @see org.apache.directory.shared.ldap.codec.LdapMessageCodec#toString()
+ /**
+ * {@inheritDoc}
*/
@Override
public String toString()
Modified: directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/ParserUtils.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/ParserUtils.java?rev=1001595&r1=1001594&r2=1001595&view=diff
==============================================================================
--- directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/ParserUtils.java (original)
+++ directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/ParserUtils.java Mon Sep 27 06:15:30 2010
@@ -54,16 +54,33 @@ import org.xmlpull.v1.XmlPullParserExcep
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
-public class ParserUtils
+public final class ParserUtils
{
+ /** W3C XML Schema URI. */
public static final String XML_SCHEMA_URI = "http://www.w3c.org/2001/XMLSchema";
+
+ /** W3C XML Schema Instance URI. */
public static final String XML_SCHEMA_INSTANCE_URI = "http://www.w3c.org/2001/XMLSchema-instance";
+
+ /** Base-64 identifier. */
public static final String BASE64BINARY = "base64Binary";
+
+ /** XSI namespace prefix. */
public static final String XSI = "xsi";
+
+ /** XSD namespace prefix. */
public static final String XSD = "xsd";
/**
+ * Private contstructor.
+ */
+ private ParserUtils()
+ {
+ }
+
+
+ /**
* Returns the value of the attribute 'type' of the "XMLSchema-instance' namespace if it exists
*
* @param xpp
Modified: directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/engine/Dsmlv2Engine.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/engine/Dsmlv2Engine.java?rev=1001595&r1=1001594&r2=1001595&view=diff
==============================================================================
--- directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/engine/Dsmlv2Engine.java (original)
+++ directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/engine/Dsmlv2Engine.java Mon Sep 27 06:15:30 2010
@@ -36,13 +36,13 @@ import org.apache.directory.shared.dsmlv
import org.apache.directory.shared.dsmlv2.reponse.CompareResponseDsml;
import org.apache.directory.shared.dsmlv2.reponse.DelResponseDsml;
import org.apache.directory.shared.dsmlv2.reponse.ErrorResponse;
+import org.apache.directory.shared.dsmlv2.reponse.ErrorResponse.ErrorResponseType;
import org.apache.directory.shared.dsmlv2.reponse.ExtendedResponseDsml;
import org.apache.directory.shared.dsmlv2.reponse.ModDNResponseDsml;
import org.apache.directory.shared.dsmlv2.reponse.ModifyResponseDsml;
import org.apache.directory.shared.dsmlv2.reponse.SearchResponseDsml;
import org.apache.directory.shared.dsmlv2.reponse.SearchResultEntryDsml;
import org.apache.directory.shared.dsmlv2.reponse.SearchResultReferenceDsml;
-import org.apache.directory.shared.dsmlv2.reponse.ErrorResponse.ErrorResponseType;
import org.apache.directory.shared.dsmlv2.request.BatchRequest;
import org.apache.directory.shared.dsmlv2.request.BatchRequest.OnError;
import org.apache.directory.shared.dsmlv2.request.BatchRequest.Processing;
@@ -51,7 +51,6 @@ import org.apache.directory.shared.i18n.
import org.apache.directory.shared.ldap.codec.MessageTypeEnum;
import org.apache.directory.shared.ldap.cursor.Cursor;
import org.apache.directory.shared.ldap.exception.LdapException;
-import org.apache.directory.shared.ldap.exception.LdapInvalidDnException;
import org.apache.directory.shared.ldap.message.AbandonRequest;
import org.apache.directory.shared.ldap.message.AddRequest;
import org.apache.directory.shared.ldap.message.AddResponse;
@@ -88,26 +87,34 @@ import org.xmlpull.v1.XmlPullParserExcep
*/
public class Dsmlv2Engine
{
- /** Socket used to connect to the server */
-
- // server configuration
+ /** The port. */
private int port;
+
+ /** The host. */
private String host;
+
+ /** The user. */
private String user;
+
+ /** The password. */
private String password;
/** The LDAP connection */
private LdapConnection connection;
+ /** The DSVMv2 parser. */
private Dsmlv2Parser parser;
+ /** The continue on error flag. */
private boolean continueOnError;
- private boolean exit = false;
- private int bbLimit;
+ /** The exit flag. */
+ private boolean exit = false;
- private int bbposition;
+ /** The batch request. */
private BatchRequest batchRequest;
+
+ /** The batch response. */
private BatchResponseDsml batchResponse;
@@ -119,7 +126,7 @@ public class Dsmlv2Engine
* @param user the server admin DN
* @param password the server admin's password
*/
- public Dsmlv2Engine( String host, int port, String user, String password ) throws IOException
+ public Dsmlv2Engine( String host, int port, String user, String password )
{
this.host = host;
this.port = port;
@@ -307,12 +314,8 @@ public class Dsmlv2Engine
* Processes a single request
*
* @param request the request to process
- * @throws EncoderException
- * @throws IOException
- * @throws DecoderException
*/
- private void processRequest( Message request ) throws EncoderException, IOException, DecoderException,
- LdapException, Exception
+ private void processRequest( Message request ) throws Exception
{
ResultCodeEnum resultCode = null;
@@ -419,6 +422,9 @@ public class Dsmlv2Engine
case UNBIND_REQUEST:
connection.unBind();
break;
+
+ default:
+ throw new IllegalStateException( "Unexpected request tpye " + request.getType() );
}
if ( ( !continueOnError ) && ( resultCode != ResultCodeEnum.SUCCESS )
@@ -485,8 +491,7 @@ public class Dsmlv2Engine
* @throws IOException
* @throws LdapInvalidDnException
*/
- private void bind( int messageId ) throws LdapException, EncoderException, DecoderException, IOException,
- LdapInvalidDnException
+ private void bind( int messageId ) throws LdapException, EncoderException, DecoderException, IOException
{
BindRequest bindRequest = new BindRequestImpl();
bindRequest.setSimple( true );
Modified: directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/AbstractResponseDsml.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/AbstractResponseDsml.java?rev=1001595&r1=1001594&r2=1001595&view=diff
==============================================================================
--- directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/AbstractResponseDsml.java (original)
+++ directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/AbstractResponseDsml.java Mon Sep 27 06:15:30 2010
@@ -22,35 +22,48 @@ package org.apache.directory.shared.dsml
import org.apache.directory.shared.dsmlv2.DsmlDecorator;
import org.apache.directory.shared.ldap.message.Message;
-import org.apache.directory.shared.ldap.message.MessageException;
import org.apache.directory.shared.ldap.message.control.Control;
import org.dom4j.Element;
/**
+ * Base class for all DSML responses.
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
public abstract class AbstractResponseDsml extends LdapResponseDecorator implements DsmlDecorator
{
+ /**
+ * Instantiates a new abstract DSML response.
+ *
+ * @param ldapMessage the LDAP message to decorate
+ */
public AbstractResponseDsml( Message ldapMessage )
{
super( ldapMessage );
- // TODO Auto-generated constructor stub
}
+ /**
+ * {@inheritDoc}
+ */
public abstract Element toDsml( Element root );
- public void addAllControls( Control[] controls ) throws MessageException
+ /**
+ * {@inheritDoc}
+ */
+ public void addAllControls( Control[] controls )
{
// TODO Auto-generated method stub
}
+ /**
+ * {@inheritDoc}
+ */
public Object get( Object key )
{
// TODO Auto-generated method stub
@@ -58,6 +71,9 @@ public abstract class AbstractResponseDs
}
+ /**
+ * {@inheritDoc}
+ */
public Control getCurrentControl()
{
// TODO Auto-generated method stub
@@ -65,6 +81,9 @@ public abstract class AbstractResponseDs
}
+ /**
+ * {@inheritDoc}
+ */
public boolean hasControl( String oid )
{
// TODO Auto-generated method stub
@@ -72,6 +91,9 @@ public abstract class AbstractResponseDs
}
+ /**
+ * {@inheritDoc}
+ */
public Object put( Object key, Object value )
{
// TODO Auto-generated method stub
@@ -79,7 +101,10 @@ public abstract class AbstractResponseDs
}
- public void removeControl( Control control ) throws MessageException
+ /**
+ * {@inheritDoc}
+ */
+ public void removeControl( Control control )
{
// TODO Auto-generated method stub
Modified: directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/AddResponseDsml.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/AddResponseDsml.java?rev=1001595&r1=1001594&r2=1001595&view=diff
==============================================================================
--- directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/AddResponseDsml.java (original)
+++ directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/AddResponseDsml.java Mon Sep 27 06:15:30 2010
@@ -55,8 +55,8 @@ public class AddResponseDsml extends Abs
}
- /* (non-Javadoc)
- * @see org.apache.directory.shared.dsmlv2.reponse.LdapMessageDecorator#getType()
+ /**
+ * {@inheritDoc}
*/
public MessageTypeEnum getType()
{
@@ -64,8 +64,8 @@ public class AddResponseDsml extends Abs
}
- /* (non-Javadoc)
- * @see org.apache.directory.shared.dsmlv2.reponse.DsmlDecorator#toDsml(org.dom4j.Element)
+ /**
+ * {@inheritDoc}
*/
public Element toDsml( Element root )
{
Modified: directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/AuthResponseDsml.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/AuthResponseDsml.java?rev=1001595&r1=1001594&r2=1001595&view=diff
==============================================================================
--- directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/AuthResponseDsml.java (original)
+++ directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/AuthResponseDsml.java Mon Sep 27 06:15:30 2010
@@ -55,8 +55,8 @@ public class AuthResponseDsml extends Ab
}
- /* (non-Javadoc)
- * @see org.apache.directory.shared.dsmlv2.reponse.LdapMessageDecorator#getType()
+ /**
+ * {@inheritDoc}
*/
public MessageTypeEnum getType()
{
@@ -64,8 +64,8 @@ public class AuthResponseDsml extends Ab
}
- /* (non-Javadoc)
- * @see org.apache.directory.shared.dsmlv2.reponse.DsmlDecorator#toDsml(org.dom4j.Element)
+ /**
+ * {@inheritDoc}
*/
public Element toDsml( Element root )
{
Modified: directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/BatchResponseDsml.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/BatchResponseDsml.java?rev=1001595&r1=1001594&r2=1001595&view=diff
==============================================================================
--- directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/BatchResponseDsml.java (original)
+++ directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/BatchResponseDsml.java Mon Sep 27 06:15:30 2010
@@ -105,7 +105,9 @@ public class BatchResponseDsml
/**
- * Converts the Batch Response to its XML representation in the DSMLv2 format.
+ * Converts this Batch Response to its XML representation in the DSMLv2 format.
+ *
+ * @return the XML representation in DSMLv2 format
*/
public String toDsml()
{
Modified: directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/CompareResponseDsml.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/CompareResponseDsml.java?rev=1001595&r1=1001594&r2=1001595&view=diff
==============================================================================
--- directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/CompareResponseDsml.java (original)
+++ directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/CompareResponseDsml.java Mon Sep 27 06:15:30 2010
@@ -55,8 +55,8 @@ public class CompareResponseDsml extends
}
- /* (non-Javadoc)
- * @see org.apache.directory.shared.dsmlv2.reponse.LdapMessageDecorator#getType()
+ /**
+ * {@inheritDoc}
*/
public MessageTypeEnum getType()
{
@@ -64,8 +64,8 @@ public class CompareResponseDsml extends
}
- /* (non-Javadoc)
- * @see org.apache.directory.shared.dsmlv2.reponse.DsmlDecorator#toDsml(org.dom4j.Element)
+ /**
+ * {@inheritDoc}
*/
public Element toDsml( Element root )
{
Modified: directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/DelResponseDsml.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/DelResponseDsml.java?rev=1001595&r1=1001594&r2=1001595&view=diff
==============================================================================
--- directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/DelResponseDsml.java (original)
+++ directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/DelResponseDsml.java Mon Sep 27 06:15:30 2010
@@ -55,8 +55,8 @@ public class DelResponseDsml extends Abs
}
- /* (non-Javadoc)
- * @see org.apache.directory.shared.dsmlv2.reponse.LdapMessageDecorator#getType()
+ /**
+ * {@inheritDoc}
*/
public MessageTypeEnum getType()
{
@@ -64,8 +64,8 @@ public class DelResponseDsml extends Abs
}
- /* (non-Javadoc)
- * @see org.apache.directory.shared.dsmlv2.reponse.DsmlDecorator#toDsml(org.dom4j.Element)
+ /**
+ * {@inheritDoc}
*/
public Element toDsml( Element root )
{
Modified: directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/Dsmlv2ResponseGrammar.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/Dsmlv2ResponseGrammar.java?rev=1001595&r1=1001594&r2=1001595&view=diff
==============================================================================
--- directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/Dsmlv2ResponseGrammar.java (original)
+++ directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/Dsmlv2ResponseGrammar.java Mon Sep 27 06:15:30 2010
@@ -83,13 +83,13 @@ import org.xmlpull.v1.XmlPullParserExcep
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
-public class Dsmlv2ResponseGrammar extends AbstractGrammar implements IGrammar
+public final class Dsmlv2ResponseGrammar extends AbstractGrammar implements IGrammar
{
/** The instance of grammar. Dsmlv2ResponseGrammar is a singleton */
private static Dsmlv2ResponseGrammar instance = new Dsmlv2ResponseGrammar();
- // Initializing DESCR_TAGS
- private static Set<String> DSMLV2_DESCR_TAGS = null;
+ /** The DSMLv2 description tags */
+ private static final Set<String> DSMLV2_DESCR_TAGS;
static
{
DSMLV2_DESCR_TAGS = new HashSet<String>();
@@ -1417,7 +1417,7 @@ public class Dsmlv2ResponseGrammar exten
// descr
attributeValue = xpp.getAttributeValue( "", "descr" );
- if ( ( attributeValue != null ) && ( DSMLV2_DESCR_TAGS.contains( attributeValue ) == false ) )
+ if ( ( attributeValue != null ) && !DSMLV2_DESCR_TAGS.contains( attributeValue ) )
{
throw new XmlPullParserException( I18n.err( I18n.ERR_03011, attributeValue ), xpp, null );
}
Modified: directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/ErrorResponse.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/ErrorResponse.java?rev=1001595&r1=1001594&r2=1001595&view=diff
==============================================================================
--- directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/ErrorResponse.java (original)
+++ directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/ErrorResponse.java Mon Sep 27 06:15:30 2010
@@ -54,7 +54,22 @@ public class ErrorResponse extends Abstr
*/
public enum ErrorResponseType
{
- NOT_ATTEMPTED, COULD_NOT_CONNECT, CONNECTION_CLOSED, MALFORMED_REQUEST, GATEWAY_INTERNAL_ERROR, AUTHENTICATION_FAILED, UNRESOLVABLE_URI, OTHER
+ /** Not attempted error response type. */
+ NOT_ATTEMPTED,
+ /** Could not connect error response type. */
+ COULD_NOT_CONNECT,
+ /** error response type. */
+ CONNECTION_CLOSED,
+ /** Malformed request error response type. */
+ MALFORMED_REQUEST,
+ /** Gateway internal error error response type. */
+ GATEWAY_INTERNAL_ERROR,
+ /** Authentication failed error response type. */
+ AUTHENTICATION_FAILED,
+ /** Unresolveable URI error response type. */
+ UNRESOLVABLE_URI,
+ /** Other error response type. */
+ OTHER
};
/** The type of error response */
@@ -69,6 +84,9 @@ public class ErrorResponse extends Abstr
/**
* Creates a new instance of ErrorResponse.
+ *
+ * @param id the response eliciting this Request
+ * @param type the message type of the response
*/
public ErrorResponse( int id, MessageTypeEnum type )
{
@@ -95,8 +113,8 @@ public class ErrorResponse extends Abstr
}
- /* (non-Javadoc)
- * @see org.apache.directory.shared.dsmlv2.reponse.DsmlDecorator#toDsml(org.dom4j.Element)
+ /**
+ * {@inheritDoc}
*/
public Element toDsml( Element root )
{
Modified: directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/ExtendedResponseDsml.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/ExtendedResponseDsml.java?rev=1001595&r1=1001594&r2=1001595&view=diff
==============================================================================
--- directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/ExtendedResponseDsml.java (original)
+++ directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/ExtendedResponseDsml.java Mon Sep 27 06:15:30 2010
@@ -59,8 +59,8 @@ public class ExtendedResponseDsml extend
}
- /* (non-Javadoc)
- * @see org.apache.directory.shared.dsmlv2.reponse.LdapMessageDecorator#getType()
+ /**
+ * {@inheritDoc}
*/
public MessageTypeEnum getType()
{
@@ -68,8 +68,8 @@ public class ExtendedResponseDsml extend
}
- /* (non-Javadoc)
- * @see org.apache.directory.shared.dsmlv2.reponse.DsmlDecorator#toDsml(org.dom4j.Element)
+ /**
+ * {@inheritDoc}
*/
public Element toDsml( Element root )
{
Modified: directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/LdapResponseDecorator.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/LdapResponseDecorator.java?rev=1001595&r1=1001594&r2=1001595&view=diff
==============================================================================
--- directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/LdapResponseDecorator.java (original)
+++ directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/LdapResponseDecorator.java Mon Sep 27 06:15:30 2010
@@ -46,8 +46,8 @@ public abstract class LdapResponseDecora
}
- /* (non-Javadoc)
- * @see org.apache.directory.shared.ldap.codec.LdapResponse#getLdapResult()
+ /**
+ * {@inheritDoc}
*/
public LdapResult getLdapResult()
{
Modified: directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/LdapResultDsml.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/LdapResultDsml.java?rev=1001595&r1=1001594&r2=1001595&view=diff
==============================================================================
--- directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/LdapResultDsml.java (original)
+++ directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/LdapResultDsml.java Mon Sep 27 06:15:30 2010
@@ -62,8 +62,8 @@ public class LdapResultDsml implements D
}
- /* (non-Javadoc)
- * @see org.apache.directory.shared.dsmlv2.reponse.DsmlDecorator#toDsml(org.dom4j.Element)
+ /**
+ * {@inheritDoc}
*/
public Element toDsml( Element root )
{
Modified: directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/LdapResultEnum.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/LdapResultEnum.java?rev=1001595&r1=1001594&r2=1001595&view=diff
==============================================================================
--- directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/LdapResultEnum.java (original)
+++ directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/LdapResultEnum.java Mon Sep 27 06:15:30 2010
@@ -20,6 +20,7 @@
package org.apache.directory.shared.dsmlv2.reponse;
+
import org.apache.directory.shared.ldap.message.ResultCodeEnum;
@@ -28,9 +29,17 @@ import org.apache.directory.shared.ldap.
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
-public class LdapResultEnum
+public final class LdapResultEnum
{
/**
+ * Private constructor.
+ */
+ private LdapResultEnum()
+ {
+ }
+
+
+ /**
* Gets the String description of a given result code
*
* @param resultCode
@@ -124,7 +133,7 @@ public class LdapResultEnum
return "other";
case UNKNOWN:
return "unknown";
-
+
default:
return "unknoxn";
}
Modified: directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/ModDNResponseDsml.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/ModDNResponseDsml.java?rev=1001595&r1=1001594&r2=1001595&view=diff
==============================================================================
--- directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/ModDNResponseDsml.java (original)
+++ directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/ModDNResponseDsml.java Mon Sep 27 06:15:30 2010
@@ -55,8 +55,8 @@ public class ModDNResponseDsml extends A
}
- /* (non-Javadoc)
- * @see org.apache.directory.shared.dsmlv2.reponse.LdapMessageDecorator#getType()
+ /**
+ * {@inheritDoc}
*/
public MessageTypeEnum getType()
{
@@ -64,8 +64,8 @@ public class ModDNResponseDsml extends A
}
- /* (non-Javadoc)
- * @see org.apache.directory.shared.dsmlv2.reponse.DsmlDecorator#toDsml(org.dom4j.Element)
+ /**
+ * {@inheritDoc}
*/
public Element toDsml( Element root )
{
Modified: directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/ModifyResponseDsml.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/ModifyResponseDsml.java?rev=1001595&r1=1001594&r2=1001595&view=diff
==============================================================================
--- directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/ModifyResponseDsml.java (original)
+++ directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/ModifyResponseDsml.java Mon Sep 27 06:15:30 2010
@@ -55,8 +55,8 @@ public class ModifyResponseDsml extends
}
- /* (non-Javadoc)
- * @see org.apache.directory.shared.dsmlv2.reponse.LdapMessageDecorator#getType()
+ /**
+ * {@inheritDoc}
*/
public MessageTypeEnum getType()
{
@@ -64,8 +64,8 @@ public class ModifyResponseDsml extends
}
- /* (non-Javadoc)
- * @see org.apache.directory.shared.dsmlv2.reponse.DsmlDecorator#toDsml(org.dom4j.Element)
+ /**
+ * {@inheritDoc}
*/
public Element toDsml( Element root )
{
Modified: directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/SearchResponse.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/SearchResponse.java?rev=1001595&r1=1001594&r2=1001595&view=diff
==============================================================================
--- directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/SearchResponse.java (original)
+++ directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/SearchResponse.java Mon Sep 27 06:15:30 2010
@@ -50,6 +50,9 @@ public class SearchResponse extends Abst
/**
* Creates a new instance of SearchResponse.
+ *
+ * @param messageId the response eliciting this Request
+ * @param type the message type of the response
*/
public SearchResponse( int messageId, MessageTypeEnum type )
{
Modified: directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/SearchResponseDsml.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/SearchResponseDsml.java?rev=1001595&r1=1001594&r2=1001595&view=diff
==============================================================================
--- directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/SearchResponseDsml.java (original)
+++ directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/SearchResponseDsml.java Mon Sep 27 06:15:30 2010
@@ -43,6 +43,8 @@ public class SearchResponseDsml extends
/**
* Creates a new instance of SearchResponseDsml.
+ *
+ * @param response the LDAP response message to decorate
*/
public SearchResponseDsml( Message response )
{
@@ -78,8 +80,8 @@ public class SearchResponseDsml extends
}
- /* (non-Javadoc)
- * @see org.apache.directory.shared.dsmlv2.DsmlDecorator#toDsml(org.dom4j.Element)
+ /**
+ * {@inheritDoc}
*/
public Element toDsml( Element root )
{
Modified: directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/SearchResultDoneDsml.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/SearchResultDoneDsml.java?rev=1001595&r1=1001594&r2=1001595&view=diff
==============================================================================
--- directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/SearchResultDoneDsml.java (original)
+++ directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/SearchResultDoneDsml.java Mon Sep 27 06:15:30 2010
@@ -55,8 +55,8 @@ public class SearchResultDoneDsml extend
}
- /* (non-Javadoc)
- * @see org.apache.directory.shared.dsmlv2.reponse.LdapMessageDecorator#getType()
+ /**
+ * {@inheritDoc}
*/
public MessageTypeEnum getType()
{
@@ -64,8 +64,8 @@ public class SearchResultDoneDsml extend
}
- /* (non-Javadoc)
- * @see org.apache.directory.shared.dsmlv2.reponse.DsmlDecorator#toDsml(org.dom4j.Element)
+ /**
+ * {@inheritDoc}
*/
public Element toDsml( Element root )
{
Modified: directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/SearchResultEntryDsml.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/SearchResultEntryDsml.java?rev=1001595&r1=1001594&r2=1001595&view=diff
==============================================================================
--- directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/SearchResultEntryDsml.java (original)
+++ directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/SearchResultEntryDsml.java Mon Sep 27 06:15:30 2010
@@ -63,8 +63,8 @@ public class SearchResultEntryDsml exten
}
- /* (non-Javadoc)
- * @see org.apache.directory.shared.dsmlv2.reponse.LdapMessageDecorator#getType()
+ /**
+ * {@inheritDoc}
*/
public MessageTypeEnum getType()
{
@@ -72,8 +72,8 @@ public class SearchResultEntryDsml exten
}
- /* (non-Javadoc)
- * @see org.apache.directory.shared.dsmlv2.reponse.DsmlDecorator#toDsml(org.dom4j.Element)
+ /**
+ * {@inheritDoc}
*/
public Element toDsml( Element root )
{
@@ -158,9 +158,10 @@ public class SearchResultEntryDsml exten
/**
- * Create a new attributeValue
+ * Create a new attribute.
*
* @param type The attribute's name
+ * @throws LdapException if the type doesn't exist
*/
public void addAttributeType( String type ) throws LdapException
{
@@ -169,9 +170,9 @@ public class SearchResultEntryDsml exten
/**
- * Add a new value to the current attribute
+ * Add a new value to the current attribute.
*
- * @param value
+ * @param value the added value
*/
public void addAttributeValue( Object value )
{
Modified: directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/SearchResultReferenceDsml.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/SearchResultReferenceDsml.java?rev=1001595&r1=1001594&r2=1001595&view=diff
==============================================================================
--- directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/SearchResultReferenceDsml.java (original)
+++ directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/reponse/SearchResultReferenceDsml.java Mon Sep 27 06:15:30 2010
@@ -59,8 +59,8 @@ public class SearchResultReferenceDsml e
}
- /* (non-Javadoc)
- * @see org.apache.directory.shared.dsmlv2.reponse.LdapMessageDecorator#getType()
+ /**
+ * {@inheritDoc}
*/
public MessageTypeEnum getType()
{
@@ -68,8 +68,8 @@ public class SearchResultReferenceDsml e
}
- /* (non-Javadoc)
- * @see org.apache.directory.shared.dsmlv2.reponse.DsmlDecorator#toDsml(org.dom4j.Element)
+ /**
+ * {@inheritDoc}
*/
public Element toDsml( Element root )
{
Modified: directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/request/AbstractRequestDsml.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/request/AbstractRequestDsml.java?rev=1001595&r1=1001594&r2=1001595&view=diff
==============================================================================
--- directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/request/AbstractRequestDsml.java (original)
+++ directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/request/AbstractRequestDsml.java Mon Sep 27 06:15:30 2010
@@ -26,6 +26,11 @@ import org.apache.directory.shared.ldap.
import org.dom4j.Element;
+/**
+ * Abstract class for DSML requests.
+ *
+ * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
+ */
public abstract class AbstractRequestDsml extends LdapRequestDecorator implements DsmlDecorator
{
/**
Modified: directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/request/BatchRequest.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/request/BatchRequest.java?rev=1001595&r1=1001594&r2=1001595&view=diff
==============================================================================
--- directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/request/BatchRequest.java (original)
+++ directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/request/BatchRequest.java Mon Sep 27 06:15:30 2010
@@ -51,7 +51,10 @@ public class BatchRequest
*/
public enum Processing
{
- SEQUENTIAL, PARALLEL
+ /** Sequential processing. */
+ SEQUENTIAL,
+ /** Parallel processing. */
+ PARALLEL
};
/**
@@ -66,7 +69,10 @@ public class BatchRequest
*/
public enum OnError
{
- RESUME, EXIT
+ /** Resume on error. */
+ RESUME,
+ /** Exit on error. */
+ EXIT
};
/**
@@ -81,7 +87,10 @@ public class BatchRequest
*/
public enum ResponseOrder
{
- SEQUENTIAL, UNORDERED
+ /** Sequential response order. */
+ SEQUENTIAL,
+ /** Unordered response order. */
+ UNORDERED
};
/**
Modified: directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/request/BatchRequestDsml.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/request/BatchRequestDsml.java?rev=1001595&r1=1001594&r2=1001595&view=diff
==============================================================================
--- directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/request/BatchRequestDsml.java (original)
+++ directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/request/BatchRequestDsml.java Mon Sep 27 06:15:30 2010
@@ -193,7 +193,9 @@ public class BatchRequestDsml
/**
- * Converts the Batch Request to its XML representation in the DSMLv2 format.
+ * Converts this Batch Request to its XML representation in the DSMLv2 format.
+ *
+ * @return the XML representation in DSMLv2 format
*/
public String toDsml()
{
Modified: directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/request/Dsmlv2Grammar.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/request/Dsmlv2Grammar.java?rev=1001595&r1=1001594&r2=1001595&view=diff
==============================================================================
--- directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/request/Dsmlv2Grammar.java (original)
+++ directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/request/Dsmlv2Grammar.java Mon Sep 27 06:15:30 2010
@@ -88,7 +88,7 @@ import org.xmlpull.v1.XmlPullParserExcep
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
-public class Dsmlv2Grammar extends AbstractGrammar implements IGrammar
+public final class Dsmlv2Grammar extends AbstractGrammar implements IGrammar
{
/** The instance of grammar. Dsmlv2Grammar is a singleton */
private static Dsmlv2Grammar instance = new Dsmlv2Grammar();
Modified: directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/request/LdapRequestDecorator.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/request/LdapRequestDecorator.java?rev=1001595&r1=1001594&r2=1001595&view=diff
==============================================================================
--- directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/request/LdapRequestDecorator.java (original)
+++ directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/request/LdapRequestDecorator.java Mon Sep 27 06:15:30 2010
@@ -22,7 +22,6 @@ package org.apache.directory.shared.dsml
import org.apache.directory.shared.dsmlv2.LdapMessageDecorator;
import org.apache.directory.shared.ldap.message.Message;
-import org.apache.directory.shared.ldap.message.MessageException;
import org.apache.directory.shared.ldap.message.control.Control;
@@ -44,25 +43,27 @@ public class LdapRequestDecorator extend
}
- public void addAllControls( Control[] controls ) throws MessageException
+ /**
+ * {@inheritDoc}
+ */
+ public void addAllControls( Control[] controls )
{
instance.addAllControls( controls );
}
+ /**
+ * {@inheritDoc}
+ */
public Object get( Object key )
{
return instance.get( key );
}
- /*
- public int getControlsLength()
- {
- return 0;
- }
- */
-
+ /**
+ * {@inheritDoc}
+ */
public Control getCurrentControl()
{
// TODO Auto-generated method stub
@@ -70,13 +71,9 @@ public class LdapRequestDecorator extend
}
- public int getMessageLength()
- {
- // TODO Auto-generated method stub
- return 0;
- }
-
-
+ /**
+ * {@inheritDoc}
+ */
public boolean hasControl( String oid )
{
// TODO Auto-generated method stub
@@ -84,6 +81,9 @@ public class LdapRequestDecorator extend
}
+ /**
+ * {@inheritDoc}
+ */
public Object put( Object key, Object value )
{
// TODO Auto-generated method stub
@@ -91,23 +91,13 @@ public class LdapRequestDecorator extend
}
- public void removeControl( Control control ) throws MessageException
- {
- // TODO Auto-generated method stub
-
- }
-
-
- public void setControlsLength( int controlsLength )
+ /**
+ * {@inheritDoc}
+ */
+ public void removeControl( Control control )
{
// TODO Auto-generated method stub
}
-
- public void setMessageLength( int messageLength )
- {
- // TODO Auto-generated method stub
-
- }
}
Modified: directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/request/SearchRequestDsml.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/request/SearchRequestDsml.java?rev=1001595&r1=1001594&r2=1001595&view=diff
==============================================================================
--- directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/request/SearchRequestDsml.java (original)
+++ directory/shared/trunk/dsml-parser/src/main/java/org/apache/directory/shared/dsmlv2/request/SearchRequestDsml.java Mon Sep 27 06:15:30 2010
@@ -135,6 +135,8 @@ public class SearchRequestDsml extends A
element.addAttribute( "derefAliases", "derefInSearching" );
break;
+ default:
+ throw new IllegalStateException( "Unexpected deref alias mode " + derefAliases );
}
// SizeLimit