Java Doc for Request.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.Request

All known Subclasses:   org.snmp4j.agent.request.AbstractRequest,
Request
public interface Request (Code)
The Request interface defines common elements of SNMP related operation requests.
author:
   Frank Fock
version:
   1.0


Field Summary
 intPHASE_1PC
    
 intPHASE_2PC_CLEANUP
    
 intPHASE_2PC_COMMIT
    
 intPHASE_2PC_PREPARE
    
 intPHASE_2PC_UNDO
    
 intPHASE_INIT
    


Method Summary
 SubRequestfind(OID prefix)
     Finds the first sub-request whose OID starts with the supplied one.
Parameters:
  prefix - the OID prefix of the sub-request OID.the first SubRequest instance of this request whose OIDstarts with prefix.
 SubRequestget(int index)
     Gets the sub-request at the specified index.
 OctetStringgetContext()
     Gets the context of the request.
 intgetErrorIndex()
    
 intgetErrorStatus()
    
 intgetMessageProcessingModel()
    
 intgetPhase()
     Gets the phase identifier of the current Two-Phase-Commit (2PC) phase of this request.
 intgetReprocessCounter()
     Returns the value of the reprocessing counter associated with this request.
 ObjectgetResponse()
     Returns the response object for this request.
 intgetSecurityLevel()
    
 intgetSecurityModel()
    
 OctetStringgetSecurityName()
    
 ObjectgetSource()
     Returns the initiating event object for the request.
 intgetTransactionID()
    
 OctetStringgetViewName()
    
 intgetViewType()
    
 voidincReprocessCounter()
     Increments the reprocess counter by one.
 booleanisComplete()
     Checks whether the response for this request is complete.
 booleanisPhaseComplete()
     Checks whether the current phase is complete. true if all required processing has been finished forthe current request phase.
 Iteratoriterator()
     Returns an Iterator over the sub-requests of this request.
 intnextPhase()
     Initializes next phase and returns its identifier.
 voidresetProcessedStatus()
     Set the processed status of each (incomplete) sub-request to false.
 voidsetErrorStatus(int errorStatus)
    
 voidsetPhase(int phase)
     Sets the request phase.
 voidsetViewName(OctetString viewName)
    
 intsize()
     Gets the number of sub-requests in this request.

Field Detail
PHASE_1PC
int PHASE_1PC(Code)



PHASE_2PC_CLEANUP
int PHASE_2PC_CLEANUP(Code)



PHASE_2PC_COMMIT
int PHASE_2PC_COMMIT(Code)



PHASE_2PC_PREPARE
int PHASE_2PC_PREPARE(Code)



PHASE_2PC_UNDO
int PHASE_2PC_UNDO(Code)



PHASE_INIT
int PHASE_INIT(Code)





Method Detail
find
SubRequest find(OID prefix)(Code)
Finds the first sub-request whose OID starts with the supplied one.
Parameters:
  prefix - the OID prefix of the sub-request OID.the first SubRequest instance of this request whose OIDstarts with prefix. If no such sub-request exitsnull is returned.



get
SubRequest get(int index)(Code)
Gets the sub-request at the specified index.
Parameters:
  index - an index >= 0 and < size()a SnmpSubRequest instance.



getContext
OctetString getContext()(Code)
Gets the context of the request. an OctetString instance.



getErrorIndex
int getErrorIndex()(Code)



getErrorStatus
int getErrorStatus()(Code)



getMessageProcessingModel
int getMessageProcessingModel()(Code)



getPhase
int getPhase()(Code)
Gets the phase identifier of the current Two-Phase-Commit (2PC) phase of this request. a 2PC identifier



getReprocessCounter
int getReprocessCounter()(Code)
Returns the value of the reprocessing counter associated with this request. The reprocessing counter can be used to detect and handle endless-loop errors caused by instrumentation code not setting the completion status of a sub-request correctly. 0 after the initial (and normally last) processing iteration andn after the n-th reprocessing iteration.
See Also:   Request.incReprocessCounter()



getResponse
Object getResponse()(Code)
Returns the response object for this request. an object containing the response for this request.



getSecurityLevel
int getSecurityLevel()(Code)



getSecurityModel
int getSecurityModel()(Code)



getSecurityName
OctetString getSecurityName()(Code)



getSource
Object getSource()(Code)
Returns the initiating event object for the request. an Object instance on whose behalf this requesthas been initiated.



getTransactionID
int getTransactionID()(Code)



getViewName
OctetString getViewName()(Code)



getViewType
int getViewType()(Code)



incReprocessCounter
void incReprocessCounter()(Code)
Increments the reprocess counter by one.
See Also:   Request.getReprocessCounter()



isComplete
boolean isComplete()(Code)
Checks whether the response for this request is complete. true if all required data has been collected to createa response for this request, false otherwise.



isPhaseComplete
boolean isPhaseComplete()(Code)
Checks whether the current phase is complete. true if all required processing has been finished forthe current request phase. For single phase request types this methodreturns the same result as Request.isComplete().



iterator
Iterator iterator()(Code)
Returns an Iterator over the sub-requests of this request. an Iterator



nextPhase
int nextPhase() throws NoSuchElementException(Code)
Initializes next phase and returns its identifier. a phase identifier.
throws:
  NoSuchElementException - if there is no next phase for this typeof request.



resetProcessedStatus
void resetProcessedStatus()(Code)
Set the processed status of each (incomplete) sub-request to false.



setErrorStatus
void setErrorStatus(int errorStatus)(Code)



setPhase
void setPhase(int phase) throws NoSuchElementException(Code)
Sets the request phase.
Parameters:
  phase - a phase identifier.
throws:
  NoSuchElementException - if there is no such phase for this typeof request.



setViewName
void setViewName(OctetString viewName)(Code)



size
int size()(Code)
Gets the number of sub-requests in this request. For GETBULK requests this number may increase over time. a positive integer (greater or equal to zero).



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