summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTed Ross <tross@apache.org>2010-07-27 20:33:42 +0000
committerTed Ross <tross@apache.org>2010-07-27 20:33:42 +0000
commit169c06b72e6c87610ce61e2cb310072f60120373 (patch)
treee5b0ff4d256a54fc0bd26f2fdea210e9c53b3f7c
parent204dcb7f9566ca36bdaaf0ce1b366c8a99b0e39d (diff)
downloadqpid-python-169c06b72e6c87610ce61e2cb310072f60120373.tar.gz
Removed unused header files.
git-svn-id: https://svn.apache.org/repos/asf/qpid/trunk/qpid@979857 13f79535-47bb-0310-9956-ffa450edef68
-rw-r--r--cpp/include/qmf/Agent.h287
-rw-r--r--cpp/include/qmf/AgentObject.h95
-rw-r--r--cpp/include/qmf/Connection.h125
-rw-r--r--cpp/include/qmf/ConnectionSettings.h32
-rw-r--r--cpp/include/qmf/ConsoleObject.h94
-rw-r--r--cpp/include/qmf/QmfImportExport.h33
-rw-r--r--cpp/src/qmf.mk8
7 files changed, 1 insertions, 673 deletions
diff --git a/cpp/include/qmf/Agent.h b/cpp/include/qmf/Agent.h
deleted file mode 100644
index e61cd737d0..0000000000
--- a/cpp/include/qmf/Agent.h
+++ /dev/null
@@ -1,287 +0,0 @@
-#ifndef _QmfAgent_
-#define _QmfAgent_
-
-/*
- * Licensed to the Apache Software Foundation (ASF) under one
- * or more contributor license agreements. See the NOTICE file
- * distributed with this work for additional information
- * regarding copyright ownership. The ASF licenses this file
- * to you under the Apache License, Version 2.0 (the
- * "License"); you may not use this file except in compliance
- * with the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied. See the License for the
- * specific language governing permissions and limitations
- * under the License.
- */
-
-#include "qmf/QmfImportExport.h"
-
-namespace qmf {
-
- class AgentImpl;
- class Connection;
- class ObjectId;
- class AgentObject;
- class Value;
- class Event;
- class SchemaObjectClass;
-
- /**
- * AgentListener is used by agents that select the internalStore=false option (see Agent
- * constructor) or by agents that wish to provide access control for queries and methods.
- *
- * \ingroup qmfapi
- */
- class AgentListener {
- QMF_EXTERN virtual ~AgentListener();
-
- /**
- * allowQuery is called before a query operation is executed. If true is returned
- * by this function, the query will proceed. If false is returned, the query will
- * be forbidden.
- *
- * @param q The query being requested.
- * @param userId The authenticated identity of the user requesting the query.
- */
- virtual bool allowQuery(const Query& q, const char* userId);
-
- /**
- * allowMethod is called before a method call is executed. If true is returned
- * by this function, the method call will proceed. If false is returned, the method
- * call will be forbidden.
- *
- * @param name The name of the method being called.
- * @param args A value object (of type "map") that contains both input and output arguments.
- * @param oid The objectId that identifies the instance of the object being called.
- * @param cls The Schema describing the object being called.
- * @param userId The authenticated identity of the requesting user.
- */
- virtual bool allowMethod(const char* name, const Value& args, const ObjectId& oid,
- const SchemaObjectClass& cls, const char* userId);
-
- /**
- * query is called when the agent receives a query request. The handler must invoke
- * Agent::queryResponse zero or more times (using the supplied context) followed by
- * a single invocation of Agent::queryComplete. These calls do not need to be made
- * synchronously in the context of this function. They may occur before or after this
- * function returns.
- *
- * This function will only be invoked if internalStore=false in the Agent's constructor.
- *
- * @param context A context value to use in resulting calls to queryResponse and quertComplete.
- * @param q The query requested by the console.
- * @param userId the authenticated identity of the user requesting the query.
- */
- virtual void query(uint32_t context, const Query& q, const char* userId);
-
- /**
- * syncStart is called when a console requests a standing query. This function must
- * behave exactly like AgentListener::query (i.e. send zero or more responses followed
- * by a queryComplete) except it then remembers the context and the query and makes
- * subsequent queryResponse calls whenever appropriate according the the query.
- *
- * The standing query shall stay in effect until syncStop is called with the same context
- * value or until a specified period of time elapses without receiving a syncTouch for the
- * context.
- *
- * This function will only be invoked if internalStore=false in the Agent's constructor.
- *
- * @param context A context value to use in resulting calls to queryResponse and queryComplete.
- * @param q The query requested by the console.
- * @param userId the authenticated identity of the user requesting the query.
- */
- virtual void syncStart(uint32_t context, const Query& q, const char* userId);
-
- /**
- * syncTouch is called when the console that requested a standing query refreshes its
- * interest in the query. The console must periodically "touch" a standing query to keep
- * it alive. This prevents standing queries from accumulating when the console disconnects
- * before it can stop the query.
- *
- * This function will only be invoked if internalStore=false in the Agent's constructor.
- *
- * @param context The context supplied in a previous call to syncStart.
- * @param userId The authenticated identity of the requesting user.
- */
- virtual void syncTouch(uint32_t context, const char* userId);
-
- /**
- * syncStop is called when the console that requested a standing query no longer wishes to
- * receive data associated with that query. The application shall stop processing this
- * query and shall remove its record of the context value.
- *
- * This function will only be invoked if internalStore=false in the Agent's constructor.
- *
- * @param context The context supplied in a previous call to syncStart.
- * @param userId The authenticated identity of the requesting user.
- */
- virtual void syncStop(uint32_t context, const char* userId);
-
- /**
- * methodCall is called when a console invokes a method on a QMF object. The application
- * must call Agent::methodResponse once in response to this function. The response does
- * not need to be called synchronously in the context of this function. It may be called
- * before or after this function returns.
- *
- * This function will only be invoked if internalStore=false in the Agent's constructor.
- *
- * @param context A context value to use in resulting call to methodResponse.
- * @param name The name of the method being called.
- * @param args A value object (of type "map") that contains both input and output arguments.
- * @param oid The objectId that identifies the instance of the object being called.
- * @param cls The Schema describing the object being called.
- * @param userId The authenticated identity of the requesting user.
- */
- virtual void methodCall(uint32_t context, const char* name, Value& args,
- const ObjectId& oid, const SchemaObjectClass& cls, const char* userId);
- };
-
- /**
- * The Agent class is the QMF Agent portal. It should be instantiated once and associated with a
- * Connection (setConnection) to connect an agent to the QMF infrastructure.
- *
- * \ingroup qmfapi
- */
- class Agent {
- public:
- /**
- * Create an instance of the Agent class.
- *
- * @param label An optional string label that can be used to identify the agent.
- *
- * @param internalStore If true, objects shall be tracked internally by the agent.
- * If false, the user of the agent must track the objects.
- * If the agent is tracking the objects, queries and syncs are handled by
- * the agent. The only involvement the user has is to optionally authorize
- * individual operations. If the user is tracking the objects, the user code
- * must implement queries and syncs (standing queries).
- *
- * @param listener A pointer to a class that implements the AgentListener interface.
- * This must be supplied if any of the following conditions are true:
- * - The agent model contains methods
- * - The user wishes to individually authorize query and sync operations.
- * - internalStore = false
- */
- QMF_EXTERN Agent(char* label="qmfa", bool internalStore=true, AgentListener* listener=0);
-
- /**
- * Destroy an instance of the Agent class.
- */
- QMF_EXTERN ~Agent();
-
- /**
- * Set the persistent store file. This file, if specified, is used to store state information
- * about the Agent. For example, if object-ids must be persistent across restarts of the Agent
- * program, this file path must be supplied.
- *
- * @param path Full path to a file that is both writable and readable by the Agent program.
- */
- QMF_EXTERN void setStoreDir(const char* path);
-
- /**
- * Provide a connection (to a Qpid broker) over which the agent can communicate.
- *
- * @param conn Pointer to a Connection object.
- */
- QMF_EXTERN void setConnection(Connection* conn);
-
- /**
- * Register a class schema (object or event) with the agent. The agent must have a registered
- * schema for an object class or an event class before it can handle objects or events of that
- * class.
- *
- * @param cls Pointer to the schema structure describing the class.
- */
- QMF_EXTERN void registerClass(SchemaObjectClass* cls);
- QMF_EXTERN void registerClass(SchemaEventClass* cls);
-
- /**
- * Add an object to the agent (for internal storage mode only).
- *
- * @param obj Reference to the object to be managed by the agent.
- *
- * @param persistent Iff true, the object ID assigned to the object shall indicate persistence
- * (i.e. the object ID shall be the same across restarts of the agent program).
- *
- * @param oid 64-bit value for the oid (if zero, the agent will assign the value).
- *
- * @param oidLo 32-bit value for the lower 32-bits of the oid.
- *
- * @param oidHi 32-bit value for the upper 32-bits of the oid.
- */
- QMF_EXTERN const ObjectId* addObject(AgentObject& obj, bool persistent=false, uint64_t oid=0);
- QMF_EXTERN const ObjectId* addObject(AgentObject& obj, bool persistent, uint32_t oidLo, uint32_t oidHi);
-
- /**
- * Allocate an object ID for an object (for external storage mode only).
- *
- * @param persistent Iff true, the object ID allocated shall indicate persistence
- * (i.e. the object ID shall be the same across restarts of the agent program).
- *
- * @param oid 64-bit value for the oid (if zero, the agent will assign the value).
- *
- * @param oidLo 32-bit value for the lower 32-bits of the oid.
- *
- * @param oidHi 32-bit value for the upper 32-bits of the oid.
- */
- QMF_EXTERN const ObjectId* allocObjectId(bool persistent=false, uint64_t oid=0);
- QMF_EXTERN const ObjectId* allocObjectId(bool persistent, uint32_t oidLo, uint32_t oidHi);
-
- /**
- * Raise a QMF event.
- *
- * @param event Reference to an event object to be raised to the QMF infrastructure.
- */
- QMF_EXTERN void raiseEvent(Event& event);
-
- /**
- * Provide a response to a query (for external storage mode only).
- *
- * @param context The context value supplied in the query (via the AgentListener interface).
- *
- * @param object A reference to the agent that matched the query criteria.
- *
- * @param prop If true, transmit the property attributes of this object.
- *
- * @param stat If true, transmit the statistic attributes of this object.
- */
- QMF_EXTERN void queryResponse(uint32_t context, AgentObject& object, bool prop = true, bool stat = true);
-
- /**
- * Indicate that a query (or the initial dump of a sync) is complete (for external storage mode only).
- *
- * @param context The context value supplied in the query/sync (via the AgentListener interface).
- */
- QMF_EXTERN void queryComplete(uint32_t context);
-
- /**
- * Provide the response to a method call.
- *
- * @param context The context value supplied in the method request (via the AgentListener interface).
- *
- * @param args The argument list from the method call. Must include the output arguments (may include
- * the input arguments).
- *
- * @param status Numerical return status: zero indicates no error, non-zero indicates error.
- *
- * @param exception Pointer to an exception value. If status is non-zero, the exception value is
- * sent to the caller. It is optional (i.e. leave the pointer as 0), or may be
- * set to any legal value. A string may be supplied, but an unmanaged object of
- * any schema may also be passed.
- */
- QMF_EXTERN void methodResponse(uint32_t context, const Value& args, uint32_t status=0,
- const Value* exception=0);
-
- private:
- AgentImpl* impl;
- };
-
-}
-
-#endif
diff --git a/cpp/include/qmf/AgentObject.h b/cpp/include/qmf/AgentObject.h
deleted file mode 100644
index a1878605eb..0000000000
--- a/cpp/include/qmf/AgentObject.h
+++ /dev/null
@@ -1,95 +0,0 @@
-#ifndef _QmfAgentObject_
-#define _QmfAgentObject_
-
-/*
- * Licensed to the Apache Software Foundation (ASF) under one
- * or more contributor license agreements. See the NOTICE file
- * distributed with this work for additional information
- * regarding copyright ownership. The ASF licenses this file
- * to you under the Apache License, Version 2.0 (the
- * "License"); you may not use this file except in compliance
- * with the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied. See the License for the
- * specific language governing permissions and limitations
- * under the License.
- */
-
-#include "qmf/QmfImportExport.h"
-
-namespace qmf {
-
- class AgentObjectImpl;
- class SchemaObjectClass;
- class ObjectId;
- class Value;
- class Agent;
-
- /**
- * AgentObject is an extension of Object with agent-specific methods added.
- *
- * \ingroup qmfapi
- */
- class AgentObject : public Object {
- public:
- /**
- * Create a new Object of a specific type.
- *
- * @param type Pointer to the schema class to use as a type for this object.
- */
- QMF_EXTERN AgentObject(const SchemaObjectClass* type);
-
- /**
- * Schedule this object for deletion. Agent objects should never be directly
- * destroyed, rather this method should be called and all pointers to this
- * object dropped. The agent will clean up and properly delete the object at
- * the appropraite time.
- */
- QMF_EXTERN void destroy();
-
- /**
- * Set the object ID for this object if it is to be managed by the agent.
- *
- * @param oid The new object ID for the managed object.
- */
- QMF_EXTERN void setObjectId(ObjectId& oid);
-
- /**
- * Handler for invoked method calls. This will only be called for objects that
- * are being managed and stored by an agent (see internalStore argument in Agent::Agent).
- * If this function is not overridden in a child class, the default implementation will
- * cause AgentListener::methodCall to be invoked in the application program.
- *
- * If this function is overridden in a sub-class, the implementation must perform
- * the actions associated with the method call (i.e. implement the method). Once the
- * method execution is complete, it must call Agent::methodResponse with the result
- * of the method execution. Agent::methodResponse does not need to be called
- * synchronously in the context of this function call. It may be called at a later
- * time from a different thread.
- *
- * @param context Context supplied by the agent and required to be passed in the
- * call to Agent::methodResponse
- *
- * @param name The name of the method.
- *
- * @param args A Value (of type map) that contains the input and output arguments.
- *
- * @param userId The authenticated identity of the user who invoked the method.
- */
- QMF_EXTERN virtual void methodInvoked(uint32_t context, const char* name, Value& args,
- const char* userId);
- private:
- friend class Agent;
- virtual ~AgentObject();
- void setAgent(Agent* agent);
- AgentObjectImpl* impl;
- };
-
-}
-
-#endif
diff --git a/cpp/include/qmf/Connection.h b/cpp/include/qmf/Connection.h
deleted file mode 100644
index f648b1427f..0000000000
--- a/cpp/include/qmf/Connection.h
+++ /dev/null
@@ -1,125 +0,0 @@
-#ifndef _QmfConnection_
-#define _QmfConnection_
-
-/*
- * Licensed to the Apache Software Foundation (ASF) under one
- * or more contributor license agreements. See the NOTICE file
- * distributed with this work for additional information
- * regarding copyright ownership. The ASF licenses this file
- * to you under the Apache License, Version 2.0 (the
- * "License"); you may not use this file except in compliance
- * with the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied. See the License for the
- * specific language governing permissions and limitations
- * under the License.
- */
-
-#include "qmf/QmfImportExport.h"
-#include "qmf/ConnectionSettings.h"
-
-namespace qmf {
-
- /**
- * Operational states for Connections.
- *
- * \ingroup qmfapi
- */
- enum ConnectionState {
- CONNECTION_UP = 1,
- CONNECTION_DOWN = 2
- };
-
- /**
- * Implement a subclass of ConnectionListener and provide it with the
- * Connection constructor to receive notification of changes in the
- * connection state.
- *
- * \ingroup qmfapi
- */
- class ConnectionListener {
- QMF_EXTERN virtual ~ConnectionListener();
-
- /**
- * Called each time the state of the connection changes.
- *
- * @param state the new state
- */
- virtual void newState(ConnectionState state);
-
- /**
- * Called if the connection requires input from an interactive client.
- *
- * @param prompt Text of the prompt - describes what information is required.
- * @param answer The interactive user input.
- * @param answerLen on Input - the maximum number of bytes that can be copied to answer.
- * on Output - the number of bytes copied to answer.
- */
- virtual void interactivePrompt(const char* prompt, char* answer, uint32_t answerLen);
- };
-
- class ConnectionImpl;
-
- /**
- * The Connection class represents a connection to a QPID broker that can
- * be used by agents and consoles, possibly multiple at the same time.
- *
- * \ingroup qmfapi
- */
- class Connection {
- public:
-
- /**
- * Creates a connection object and begins the process of attempting to
- * connect to the QPID broker.
- *
- * @param settings The settings that control how the connection is set
- * up.
- *
- * @param listener An optional pointer to a subclass of
- * ConnectionListener to receive notifications of events related to
- * this connection.
- */
- QMF_EXTERN Connection(const ConnectionSettings& settings,
- const ConnectionListener* listener = 0);
-
- /**
- * Destroys a connection, causing the connection to be closed.
- */
- QMF_EXTERN ~Connection();
-
- /**
- * Set the administrative state of the connection (enabled or disabled).
- *
- * @param enabled True => enable connection, False => disable connection
- */
- QMF_EXTERN void setAdminState(bool enabled);
-
- /**
- * Return the current operational state of the connection (up or down).
- *
- * @return the current connection state.
- */
- QMF_EXTERN ConnectionState getOperState() const;
-
- /**
- * Get the error message from the last failure to connect.
- *
- * @return Null-terminated string containing the error message.
- */
- QMF_EXTERN const char* getLastError() const;
-
- private:
- friend class AgentImpl;
- friend class ConsoleImpl;
- ConnectionImpl* impl;
- };
-
-}
-
-#endif
diff --git a/cpp/include/qmf/ConnectionSettings.h b/cpp/include/qmf/ConnectionSettings.h
deleted file mode 100644
index 11af73d797..0000000000
--- a/cpp/include/qmf/ConnectionSettings.h
+++ /dev/null
@@ -1,32 +0,0 @@
-#ifndef _QmfConnectionSettings_
-#define _QmfConnectionSettings_
-
-/*
- * Licensed to the Apache Software Foundation (ASF) under one
- * or more contributor license agreements. See the NOTICE file
- * distributed with this work for additional information
- * regarding copyright ownership. The ASF licenses this file
- * to you under the Apache License, Version 2.0 (the
- * "License"); you may not use this file except in compliance
- * with the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied. See the License for the
- * specific language governing permissions and limitations
- * under the License.
- */
-
-namespace qmf {
- namespace engine {
- class ConnectionSettings;
- }
-
- typedef class engine::ConnectionSettings ConnectionSettings;
-}
-
-#endif
-
diff --git a/cpp/include/qmf/ConsoleObject.h b/cpp/include/qmf/ConsoleObject.h
deleted file mode 100644
index acbc285e05..0000000000
--- a/cpp/include/qmf/ConsoleObject.h
+++ /dev/null
@@ -1,94 +0,0 @@
-#ifndef _QmfConsoleObject_
-#define _QmfConsoleObject_
-
-/*
- * Licensed to the Apache Software Foundation (ASF) under one
- * or more contributor license agreements. See the NOTICE file
- * distributed with this work for additional information
- * regarding copyright ownership. The ASF licenses this file
- * to you under the Apache License, Version 2.0 (the
- * "License"); you may not use this file except in compliance
- * with the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied. See the License for the
- * specific language governing permissions and limitations
- * under the License.
- */
-
-#include "qmf/QmfImportExport.h"
-
-namespace qmf {
-
- class ConsoleObjectImpl;
- class SchemaObjectClass;
- class ObjectId;
- class Value;
-
- /**
- * ConsoleObject is an extension of Object with console-specific methods added.
- *
- * \ingroup qmfapi
- */
- class ConsoleObject : public Object {
- public:
- /**
- * Create a new Object of a specific type.
- *
- * @param type Pointer to the schema class to use as a type for this object.
- */
- QMF_EXTERN ConsoleObject(const SchemaObjectClass* type);
-
- /**
- * Destroy the object.
- */
- QMF_EXTERN virtual ~ConsoleObject();
-
- /**
- *
- */
- QMF_EXTERN const SchemaObjectClass* getSchema() const;
-
- /**
- *
- */
- QMF_EXTERN ObjectId* getObjectId() const;
-
- /**
- *
- */
- QMF_EXTERN uint64_t getCurrentTime() const;
- QMF_EXTERN uint64_t getCreateTime() const;
- QMF_EXTERN uint64_t getDeleteTime() const;
-
- /**
- *
- */
- QMF_EXTERN bool isDeleted() const;
-
- /**
- *
- */
- QMF_EXTERN void update();
-
- /**
- *
- */
- QMF_EXTERN void invokeMethod(const char* name, const Value* arguments, MethodResult& result);
-
- /**
- *
- */
- QMF_EXTERN uint32_t invokeMethodAsync(const char* name, const Value* arguments = 0);
-
- private:
- ConsoleObjectImpl* impl;
- };
-
-}
-
-#endif
diff --git a/cpp/include/qmf/QmfImportExport.h b/cpp/include/qmf/QmfImportExport.h
deleted file mode 100644
index f5e1d9127c..0000000000
--- a/cpp/include/qmf/QmfImportExport.h
+++ /dev/null
@@ -1,33 +0,0 @@
-#ifndef QMF_IMPORT_EXPORT_H
-#define QMF_IMPORT_EXPORT_H
-
-/*
- * Licensed to the Apache Software Foundation (ASF) under one
- * or more contributor license agreements. See the NOTICE file
- * distributed with this work for additional information
- * regarding copyright ownership. The ASF licenses this file
- * to you under the Apache License, Version 2.0 (the
- * "License"); you may not use this file except in compliance
- * with the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied. See the License for the
- * specific language governing permissions and limitations
- * under the License.
- */
-
-#if defined(WIN32) && !defined(QPID_DECLARE_STATIC)
-# if defined(QMF_EXPORT) || defined (qmfcommon_EXPORTS)
-# define QMF_EXTERN __declspec(dllexport)
-# else
-# define QMF_EXTERN __declspec(dllimport)
-# endif
-#else
-# define QMF_EXTERN
-#endif
-
-#endif
diff --git a/cpp/src/qmf.mk b/cpp/src/qmf.mk
index 93f18179ca..dca8262333 100644
--- a/cpp/src/qmf.mk
+++ b/cpp/src/qmf.mk
@@ -29,13 +29,7 @@ lib_LTLIBRARIES += \
#
QMF_API = \
../include/qpid/agent/ManagementAgent.h \
- ../include/qpid/agent/QmfAgentImportExport.h \
- ../include/qmf/Agent.h \
- ../include/qmf/Connection.h \
- ../include/qmf/QmfImportExport.h \
- ../include/qmf/ConnectionSettings.h \
- ../include/qmf/AgentObject.h
-
+ ../include/qpid/agent/QmfAgentImportExport.h
#
# Public headers for the QMF Engine API
#