SAP ABAP Class CL_RSPO_SAPSPRINT_SNMP (SNMP API for spool WPs)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-CCM-PRN (Application Component) Print and Output Management
     ⤷ SPOO (Package) Spool

Properties

Class	CL_RSPO_SAPSPRINT_SNMP
Short Description	SNMP API for spool WPs
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status	P	SAP Standard Production Program
Category	0
Package	SPOO	Spool
Created	20080701	SAP
Last change	20090618	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	CL_RSPO_SNMP	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
2	T	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_RSPO_SAPSPRINT_SNMP has no interface implemented.

Friends

Class CL_RSPO_SAPSPRINT_SNMP has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	SNMP_ERR_INTERNAL_ERROR	Constant	Private	☐	Type reference (TYPE)	INT4	5	SNMP error: Internal error	20081125
2	SNMP_ERR_INVALID_OID	Constant	Private	☐	Type reference (TYPE)	INT4	2	SNMP error: Invalid object identifier	20081125
3	SNMP_ERR_PACKET_ERROR	Constant	Private	☐	Type reference (TYPE)	INT4	3	SNMP error: Packet error	20081125
4	SNMP_ERR_TIME_OUT	Constant	Private	☐	Type reference (TYPE)	INT4	4	SNMP error: Time out	20081125
5	SNMP_ERR_UNKNOWN_HOST	Constant	Private	☐	Type reference (TYPE)	INT4	1	SNMP error: Unknown host	20081125

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20081125
2	GET	Static method	Public	Method	SNMP GET request: Public method	20081125
3	PRV_GET	Static method	Private	Method	SNMP GET request: Private kernel module	20081125
4	PRV_WALK	Static method	Private	Method	SNMP WALK function:Private kernel module	20081125
5	WALK	Static method	Public	Method	SNMP WALK request: Public method	20081125

Events

Class CL_RSPO_SAPSPRINT_SNMP has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	T_SNMP_RESPONSE_ENTRY	Private	See coding			20081125	BEGIN OF t_snmp_response_entry, oid TYPE c LENGTH 512, datatype TYPE c LENGTH 32, response TYPE c LENGTH 512, END OF t_snmp_response_entry
2	T_SNMP_RESPONSE_TAB	Private	See coding			20081125	t_snmp_response_tab TYPE STANDARD TABLE OF t_snmp_response_entry
3	T_SNMP_WALK_ENTRY	Public	See coding			20081125	BEGIN OF t_snmp_walk_entry , oid TYPE string, datatype TYPE string, response TYPE string, END OF t_snmp_walk_entry
4	T_SNMP_WALK_TAB	Public	See coding			20081125	t_snmp_walk_tab TYPE STANDARD TABLE OF t_snmp_walk_entry

Method Signatures

Method CONSTRUCTOR Signature

Method CONSTRUCTOR on class CL_RSPO_SAPSPRINT_SNMP has no parameter.
Method CONSTRUCTOR on class CL_RSPO_SAPSPRINT_SNMP has no exception.

Method GET Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	COMMUNITY	Call by reference	☐	Type reference (TYPE)	STRING	'public'	Community string	20081125
2	Importing	HOST	Call by reference	☐	Type reference (TYPE)	STRING		SAPSprint host or IP address	20081125
3	Importing	OID	Call by reference	☐	Type reference (TYPE)	STRING		OID string	20081125
4	Importing	PORT	Call by reference	☐	Type reference (TYPE)	STRING	'515'	SAPSprint Port	20081125
5	Importing	PRINTER_NAME	Call by reference	☐	Type reference (TYPE)	STRING		Windows printer name	20081125
6	Exporting	RESPONSE	Call by reference	☐	Type reference (TYPE)	STRING		SNMP response string	20081125
7	Importing	VERSION	Call by reference	☐	Type reference (TYPE)	STRING	'1'	SNMP version	20081125

#	Exception	Resumable	Description	Created on
1	CX_SNMP_INTERNAL_ERROR	☐	SNMP internal error	20081125
2	CX_SNMP_INVALID_OID	☐	Requested OID could not be resolved .	20081125
3	CX_SNMP_PACKET_ERROR	☐	An SNMP packet error occured.	20081125
4	CX_SNMP_TIME_OUT	☐	A SNMP 'Time Out' error occured.	20081125
5	CX_SNMP_UNKNOWN_HOST	☐	Domain name or dotted IP address of SAPSprint host not valid	20081125

Method PRV_GET Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	COMMUNITY	Call by reference	☐	Type reference (TYPE)	STRING		SNMP community	20081125
2	Importing	HOST	Call by reference	☐	Type reference (TYPE)	STRING		SAPSprint host name or IP address	20081125
3	Importing	PORT	Call by reference	☐	Type reference (TYPE)	STRING		SAPSprint port	20081125
4	Importing	PRINTER	Call by reference	☐	Type reference (TYPE)	STRING		Printer network address	20081125
5	Exporting	RC	Call by reference	☐	Type reference (TYPE)	INT4		Return code	20081125
6	Importing	REQUEST_OID	Call by reference	☐	Type reference (TYPE)	STRING		OID identifier of request	20081125
7	Exporting	RESPONSE	Call by reference	☐	Type reference (TYPE)	T_SNMP_RESPONSE_TAB		SNMP server response	20081125
8	Importing	VERSION	Call by reference	☐	Type reference (TYPE)	STRING		SNMP version	20081125

Method PRV_GET on class CL_RSPO_SAPSPRINT_SNMP has no exception.

Method PRV_WALK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	COMMUNITY	Call by reference	☐	Type reference (TYPE)	STRING		SNMP community	20081125
2	Importing	HOST	Call by reference	☐	Type reference (TYPE)	STRING		SAPSprint host name or IP address	20081125
3	Importing	PORT	Call by reference	☐	Type reference (TYPE)	STRING		SAPSprint port	20081125
4	Importing	PRINTER	Call by reference	☐	Type reference (TYPE)	STRING		Printer network address	20081125
5	Exporting	RC	Call by reference	☐	Type reference (TYPE)	INT4		Return code	20081125
6	Importing	REQUEST_OID	Call by reference	☐	Type reference (TYPE)	STRING		OID identifier of request	20081125
7	Exporting	RESPONSE	Call by reference	☐	Type reference (TYPE)	T_SNMP_RESPONSE_TAB		SNMP server response	20081125
8	Importing	VERSION	Call by reference	☐	Type reference (TYPE)	STRING		SNMP version	20081125

Method PRV_WALK on class CL_RSPO_SAPSPRINT_SNMP has no exception.

Method WALK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	COMMUNITY	Call by reference	☐	Type reference (TYPE)	STRING		SNMP community	20081125
2	Importing	HOST	Call by reference	☐	Type reference (TYPE)	STRING		SAPSprint host or IP address	20081125
3	Importing	OID	Call by reference	☐	Type reference (TYPE)	STRING		OID identifier of request	20081125
4	Importing	PORT	Call by reference	☐	Type reference (TYPE)	STRING	'515'	SAPSprint port	20081125
5	Importing	PRINTER_NAME	Call by reference	☐	Type reference (TYPE)	STRING		Printer network address	20081125
6	Exporting	RESPONSE	Call by reference	☐	Type reference (TYPE)	CL_RSPO_SNMP=>T_SNMP_WALK_TAB		SNMP server response	20081125
7	Importing	VERSION	Call by reference	☐	Type reference (TYPE)	STRING		SNMP version	20081125

#	Exception	Resumable	Description	Created on
1	CX_SNMP_INTERNAL_ERROR	☐	SNMP internal error	20081125
2	CX_SNMP_INVALID_OID	☐	Requested OID could not be resolved .	20081125
3	CX_SNMP_PACKET_ERROR	☐	An SNMP packet error occured.	20081125
4	CX_SNMP_TIME_OUT	☐	A SNMP 'Time Out' error occured.	20081125
5	CX_SNMP_UNKNOWN_HOST	☐	Domain name or dotted IP address of SNMP host unknown	20081125

History

Last changed by/on	SAP	20090618
SAP Release Created in