Java Doc for SubRequest.java in  » Net » snmp4j » org » snmp4j » agent » request » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Net » snmp4j » org.snmp4j.agent.request 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.snmp4j.agent.request.SubRequest

SubRequest
public interface SubRequest (Code)
The SubRequest interface defines
author:
   Frank Fock
version:
   1.0.1




Method Summary
 voidcompleted()
     Marks the sub-request as completed.
 intgetErrorStatus()
     Gets the error status for this sub-request.
 intgetIndex()
     Returns the index of this subrequest in the request.
 MOQuerygetQuery()
     Gets the query previously associated with this sub-request.
 RequestgetRequest()
     Gets the request this sub-request belongs to.
 MOScopegetScope()
     Gets the scope for this subrequest.
 RequestStatusgetStatus()
     Gets the status object associated with this sub-request.
 ManagedObjectgetTargetMO()
     Gets the ManagedObject that is responsible for processing this sub-request.
 ObjectgetUndoValue()
     Gets the undo value object associated with this sub-request.
 ObjectgetUserObject()
     Gets the user object that has previously associated with this sub-request.
 VariableBindinggetVariableBinding()
     Returns the variable binding associated with the sub-request.
 booleanhasError()
     Indicates whether this (sub-)request has an error.
 booleanisComplete()
     Checks whether the sub-request has been completed and needs no further processing.
 SubRequestIteratorrepetitions()
     Returns an iterator on the repetitions of this sub-request.
 voidsetErrorStatus(int errorStatus)
     Sets the error status for this sub-request.
 voidsetQuery(MOQuery query)
     Sets the query associated with this subrequest.
 voidsetTargetMO(ManagedObject managedObject)
     Sets the ManagedObject that is determined as the target object of this sub-request by the agent framework.
 voidsetUndoValue(Object undoInformation)
     Associates an undo value object with this sub-request.
 voidsetUserObject(Object userObject)
     Sets the user object.
 voidupdateNextRepetition()
     Updates the next repetition's scope and reset any previously set query to null.



Method Detail
completed
void completed()(Code)
Marks the sub-request as completed. This is a shortcut for calling SubRequest.getStatus() and then RequestStatus.setPhaseComplete to true.



getErrorStatus
int getErrorStatus()(Code)
Gets the error status for this sub-request. Calling this method is a shortcut for SubRequest.getStatus() .getErrorStatus() . a SNMPv2/v3 error status.
since:
   1.0.1



getIndex
int getIndex()(Code)
Returns the index of this subrequest in the request. the zero based index.



getQuery
MOQuery getQuery()(Code)
Gets the query previously associated with this sub-request. A sub-request is associated during requests processing with a instrumentation query. a MOQuery that describes which manage objects matchthis sub-request.



getRequest
Request getRequest()(Code)
Gets the request this sub-request belongs to. a Request instance.



getScope
MOScope getScope()(Code)
Gets the scope for this subrequest. The scope is solely defined by this sub-request and possible request processing that has already excluded managed objects from the scope of this sub-request. a MOScope instance.



getStatus
RequestStatus getStatus()(Code)
Gets the status object associated with this sub-request. a RequestStatus instance.



getTargetMO
ManagedObject getTargetMO()(Code)
Gets the ManagedObject that is responsible for processing this sub-request. ManagedObject instance.



getUndoValue
Object getUndoValue()(Code)
Gets the undo value object associated with this sub-request. an Object that has previously been associated with this request bycalling SubRequest.setUndoValue.



getUserObject
Object getUserObject()(Code)
Gets the user object that has previously associated with this sub-request. an object.
since:
   1.0.1



getVariableBinding
VariableBinding getVariableBinding()(Code)
Returns the variable binding associated with the sub-request. In order to process a sub-request this variable binding needs to be modified (if not an error condition prevents that). the VariableBinding that holds the sub-request resultor operation parameter (in case of a SET request).



hasError
boolean hasError()(Code)
Indicates whether this (sub-)request has an error. true if this request (and thus also this sub-request) hasan error status greater than zero.



isComplete
boolean isComplete()(Code)
Checks whether the sub-request has been completed and needs no further processing. true if the sub-request has been finished and should notbe processed any more.



repetitions
SubRequestIterator repetitions()(Code)
Returns an iterator on the repetitions of this sub-request. On requests other than GETBULK requests this method returns an empty iterator. a SubRequestIterator enumerating the repetitions on this sub-requestsstarting with this sub-request.



setErrorStatus
void setErrorStatus(int errorStatus)(Code)
Sets the error status for this sub-request. Calling this method is a shortcut for SubRequest.getStatus() .setErrorStatus(int errorStatus) .
Parameters:
  errorStatus - a SNMPv2/v3 error status.
since:
   1.0.1



setQuery
void setQuery(MOQuery query)(Code)
Sets the query associated with this subrequest. The query is not used by the request itself but may be stored here for further reference while processing this sub-requests.
Parameters:
  query - a MOQuery instance representing the query resulting fromthis sub-request.



setTargetMO
void setTargetMO(ManagedObject managedObject)(Code)
Sets the ManagedObject that is determined as the target object of this sub-request by the agent framework. For SET requests the target managed object is locked and referenced here to make sure that all locks are released when a request is answered. In addition, SET requests are processed in multiple phases and referencing the target managed objects increases performance.
Parameters:
  managedObject - the ManagedObject responsible for processing this sub-request.



setUndoValue
void setUndoValue(Object undoInformation)(Code)
Associates an undo value object with this sub-request. The undo value is internally used by the SNMP4J-Agent API and should therefore not be altered externally. One exception to this rule is an implementation of the ManagedObject interface that does not extend any other API class.
Parameters:
  undoInformation - an object that represents/contains all necessary information to undothis sub-request.



setUserObject
void setUserObject(Object userObject)(Code)
Sets the user object. The user object can be used to associate resources or any other type of information necessary for a managed object instance to process a SNMP request. When the request is processed, this reference will be set to null.
Parameters:
  userObject - an object that is not processed or interpreted by the agent API.
since:
   1.0.1



updateNextRepetition
void updateNextRepetition()(Code)
Updates the next repetition's scope and reset any previously set query to null. The scope of the next repetition is updated according to the value of this variable binding. If this sub-request has an error status or exception value, the following repetitions are set to the same value and exception. Otherwise, the scope of the following sub-request is the open interval from this sub-request's OID (not-including) to any OID value.



www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.