Commit bb4518d6 authored by Andre Freyssinet's avatar Andre Freyssinet

Javadoc enhancements.

parent df659c93
/*
* JORAM: Java(TM) Open Reliable Asynchronous Messaging
* Copyright (C) 2001 - 2006 ScalAgent Distributed Technologies
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
* USA.
*
* Initial developer(s): ScalAgent Distributed Technologies
* Contributor(s):
*/
package org.objectweb.joram.shared.excepts;
import org.objectweb.joram.shared.client.MomExceptionReply;
/**
* An <code>AccessException</code> is thrown by a destination when processing
* a request of a client which does not have valid rights for this request.
*/
public class AccessException extends MomException {
/**
*
*/
private static final long serialVersionUID = 1L;
/**
* Constructs an <code>AccessException</code> instance.
*/
public AccessException(String info) {
super(info);
type = MomExceptionReply.AccessException;
}
}
/*
* JORAM: Java(TM) Open Reliable Asynchronous Messaging
* Copyright (C) 2001 - 2020 ScalAgent Distributed Technologies
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
* USA.
*
* Initial developer(s): ScalAgent Distributed Technologies
* Contributor(s):
*/
package org.objectweb.joram.shared.excepts;
import org.objectweb.joram.shared.client.MomExceptionReply;
/**
* An <code>AccessException</code> is thrown by a destination when processing
* a request of a client which does not have valid rights for this request.
*/
public class AccessException extends MomException {
/** define serialVersionUID for interoperability */
private static final long serialVersionUID = 1L;
/**
* Constructs an <code>AccessException</code> instance.
*
* @param info Information.
*/
public AccessException(String info) {
super(info);
type = MomExceptionReply.AccessException;
}
}
/*
* JORAM: Java(TM) Open Reliable Asynchronous Messaging
* Copyright (C) 2001 - 2006 ScalAgent Distributed Technologies
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
* USA.
*
* Initial developer(s): ScalAgent Distributed Technologies
* Contributor(s):
*/
package org.objectweb.joram.shared.excepts;
import org.objectweb.joram.shared.client.MomExceptionReply;
/**
* A <code>DestinationException</code> is thrown by a destination while
* deleting if requesters are still active, and in a proxy method when trying
* to access a non existing destination.
*/
public class DestinationException extends MomException {
/**
*
*/
private static final long serialVersionUID = 1L;
/**
* Constructs a <code>DestinationException</code> instance.
*/
public DestinationException(String info) {
super(info);
type = MomExceptionReply.DestinationException;
}
}
/*
* JORAM: Java(TM) Open Reliable Asynchronous Messaging
* Copyright (C) 2001 - 2020 ScalAgent Distributed Technologies
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
* USA.
*
* Initial developer(s): ScalAgent Distributed Technologies
* Contributor(s):
*/
package org.objectweb.joram.shared.excepts;
import org.objectweb.joram.shared.client.MomExceptionReply;
/**
* A <code>DestinationException</code> is thrown by a destination while
* deleting if requesters are still active, and in a proxy method when trying
* to access a non existing destination.
*/
public class DestinationException extends MomException {
/** define serialVersionUID for interoperability */
private static final long serialVersionUID = 1L;
/**
* Constructs a <code>DestinationException</code> instance.
*
* @param info Information.
*/
public DestinationException(String info) {
super(info);
type = MomExceptionReply.DestinationException;
}
}
/*
* JORAM: Java(TM) Open Reliable Asynchronous Messaging
* Copyright (C) 2001 - 2011 ScalAgent Distributed Technologies
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
* USA.
*
* Initial developer(s): ScalAgent Distributed Technologies
* Contributor(s):
*/
package org.objectweb.joram.shared.excepts;
import org.objectweb.joram.shared.client.MomExceptionReply;
/**
* A <code>MessageValueException</code> is thrown when a value carried by a
* message is incorrectly accessed or typed.
*/
public class MessageValueException extends MomException {
/**
*
*/
private static final long serialVersionUID = 1L;
/**
* Constructs a <code>MessageValueException</code> instance.
*/
public MessageValueException(String info) {
super(info);
type = MomExceptionReply.MessageValueException;
}
}
/*
* JORAM: Java(TM) Open Reliable Asynchronous Messaging
* Copyright (C) 2001 - 2020 ScalAgent Distributed Technologies
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
* USA.
*
* Initial developer(s): ScalAgent Distributed Technologies
* Contributor(s):
*/
package org.objectweb.joram.shared.excepts;
import org.objectweb.joram.shared.client.MomExceptionReply;
/**
* A <code>MessageValueException</code> is thrown when a value carried by a
* message is incorrectly accessed or typed.
*/
public class MessageValueException extends MomException {
/** define serialVersionUID for interoperability */
private static final long serialVersionUID = 1L;
/**
* Constructs a <code>MessageValueException</code> instance.
*
* @param info Information.
*/
public MessageValueException(String info) {
super(info);
type = MomExceptionReply.MessageValueException;
}
}
/*
* JORAM: Java(TM) Open Reliable Asynchronous Messaging
* Copyright (C) 2001 - 2006 ScalAgent Distributed Technologies
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
* USA.
*
* Initial developer(s): ScalAgent Distributed Technologies
* Contributor(s):
*/
package org.objectweb.joram.shared.excepts;
import org.objectweb.joram.shared.client.MomExceptionReply;
/**
* The <code>MomException</code> class is the exception class thrown by the
* MOM actors.
*/
public class MomException extends Exception {
/**
*
*/
private static final long serialVersionUID = 1L;
protected int type;
public MomException(int type, String info) {
super(info);
this.type = type;
}
/**
* Constructs a <code>MomException</code> containing a given description.
*/
public MomException(String info) {
super(info);
type = MomExceptionReply.MomException;
}
public int getType() {
return type;
}
}
/*
* JORAM: Java(TM) Open Reliable Asynchronous Messaging
* Copyright (C) 2001 - 2020 ScalAgent Distributed Technologies
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
* USA.
*
* Initial developer(s): ScalAgent Distributed Technologies
* Contributor(s):
*/
package org.objectweb.joram.shared.excepts;
import org.objectweb.joram.shared.client.MomExceptionReply;
/**
* The <code>MomException</code> class is the exception class thrown by the
* MOM actors.
*/
public class MomException extends Exception {
/** define serialVersionUID for interoperability */
private static final long serialVersionUID = 1L;
protected int type;
public MomException(int type, String info) {
super(info);
this.type = type;
}
/**
* Constructs a <code>MomException</code> containing a given description.
*
* @param info Information.
*/
public MomException(String info) {
super(info);
type = MomExceptionReply.MomException;
}
public int getType() {
return type;
}
}
/*
* JORAM: Java(TM) Open Reliable Asynchronous Messaging
* Copyright (C) 2001 - 2006 ScalAgent Distributed Technologies
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
* USA.
*
* Initial developer(s): ScalAgent Distributed Technologies
* Contributor(s):
*/
package org.objectweb.joram.shared.excepts;
import org.objectweb.joram.shared.client.MomExceptionReply;
/**
* A <code>RequestException</code> is thrown by a destination or a proxy when
* processing an invalid client request.
*/
public class RequestException extends MomException {
/**
*
*/
private static final long serialVersionUID = 1L;
/**
* Constructs a <code>RequestException</code> instance.
*/
public RequestException(String info) {
super(info);
type = MomExceptionReply.RequestException;
}
}
/*
* JORAM: Java(TM) Open Reliable Asynchronous Messaging
* Copyright (C) 2001 - 2020 ScalAgent Distributed Technologies
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
* USA.
*
* Initial developer(s): ScalAgent Distributed Technologies
* Contributor(s):
*/
package org.objectweb.joram.shared.excepts;
import org.objectweb.joram.shared.client.MomExceptionReply;
/**
* A <code>RequestException</code> is thrown by a destination or a proxy when
* processing an invalid client request.
*/
public class RequestException extends MomException {
/** define serialVersionUID for interoperability */
private static final long serialVersionUID = 1L;
/**
* Constructs a <code>RequestException</code> instance.
*
* @param info Information.
*/
public RequestException(String info) {
super(info);
type = MomExceptionReply.RequestException;
}
}
/*
* JORAM: Java(TM) Open Reliable Asynchronous Messaging
* Copyright (C) 2001 - 2006 ScalAgent Distributed Technologies
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
* USA.
*
* Initial developer(s): ScalAgent Distributed Technologies
* Contributor(s):
*/
package org.objectweb.joram.shared.excepts;
import org.objectweb.joram.shared.client.MomExceptionReply;
/**
* A <code>SelectorException</code> is thrown when an error occurs while
* parsing a selector expression.
*/
public class SelectorException extends MomException {
/**
*
*/
private static final long serialVersionUID = 1L;
/**
* Constructs a <code>SelectorException</code> instance.
*/
public SelectorException(String info) {
super(info);
type = MomExceptionReply.SelectorException;
}
}
/*
* JORAM: Java(TM) Open Reliable Asynchronous Messaging
* Copyright (C) 2001 - 2020 ScalAgent Distributed Technologies
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
* USA.
*
* Initial developer(s): ScalAgent Distributed Technologies
* Contributor(s):
*/
package org.objectweb.joram.shared.excepts;
import org.objectweb.joram.shared.client.MomExceptionReply;
/**
* A <code>SelectorException</code> is thrown when an error occurs while
* parsing a selector expression.
*/
public class SelectorException extends MomException {
/** define serialVersionUID for interoperability */
private static final long serialVersionUID = 1L;
/**
* Constructs a <code>SelectorException</code> instance.
*
* @param info Information.
*/
public SelectorException(String info) {
super(info);
type = MomExceptionReply.SelectorException;
}
}
/*
* JORAM: Java(TM) Open Reliable Asynchronous Messaging
* Copyright (C) 2001 - 2006 ScalAgent Distributed Technologies
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
* USA.
*
* Initial developer(s): ScalAgent Distributed Technologies
* Contributor(s):
*/
package org.objectweb.joram.shared.excepts;
import org.objectweb.joram.shared.client.MomExceptionReply;
/**
* A <code>StateException</code> is thrown by a destination or a proxy when
* processing a request in an invalid state.
*/
public class StateException extends MomException {
/**
*
*/
private static final long serialVersionUID = 1L;
/**
* Constructs a <code>Statexception</code> instance.
*/
public StateException(String info) {
super(info);