public interface CDRProvider
Modifier and Type | Method and Description |
---|---|
CdrFileType |
getFileFormat()
This method is similar to
getFileFormat(String streamName) but
is targeted towards the default stream. |
CdrFileType |
getFileFormat(String streamName)
Get the CDR file format of the given stream that this entity is configured to write.
|
boolean |
isOperational()
This method is similar to
isOperational(String streamName) but
is targeted towards the default stream. |
boolean |
isOperational(String streamName)
Check to see if a future call to writeCDR to given stream is likely to succeed.
|
void |
writeCDR(CallDetailRecord cdr)
Deprecated.
Prefer use of
writeCDR(String) or writeCDR(Message) |
void |
writeCDR(ExtensionMessage cdr)
This method is similar to
writeCDR(ExtensionMessage
extensionCdr, String streamName) but is targeted towards the default stream. |
void |
writeCDR(ExtensionMessage cdr,
String streamName)
Record a binary-format CDR with extension definitions to given stream.
|
void |
writeCDR(com.google.protobuf.Message cdr)
This method is similar to
writeCDR(Message cdr, String
streamName) but is targeted towards the default stream. |
void |
writeCDR(com.google.protobuf.Message cdr,
String streamName)
Record a binary-format CDR to given stream.
|
void |
writeCDR(String cdr)
This method is similar to
writeCDR(String cdr, String
streamName) but is targeted towards the default stream. |
void |
writeCDR(String cdr,
String streamName)
Record a string-format CDR to given stream.
|
void writeCDR(String cdr) throws WriteTimeoutException, StreamNotFoundException, IOException
writeCDR(String cdr, String
streamName)
but is targeted towards the default stream.cdr
- the string to write.WriteTimeoutException
- if the CDR cannot be written within the entity's configured
write timeout.StreamNotFoundException
- if the RA did not initialise properly, or the default
stream is missing.IOException
- if the CDR cannot be written due to a write error.writeCDR(String, String)
void writeCDR(String cdr, String streamName) throws WriteTimeoutException, StreamNotFoundException, IOException
cdr
- the string to write.streamName
- the name of the stream to write to.WriteTimeoutException
- if the CDR cannot be written within the entity's configured
write timeout.StreamNotFoundException
- if the RA did not initialise properly, or the stream is
missing.IOException
- if the CDR cannot be written due to a write error.void writeCDR(com.google.protobuf.Message cdr) throws WriteTimeoutException, StreamNotFoundException, IOException
writeCDR(Message cdr, String
streamName)
but is targeted towards the default stream.
If this CDR entity is configured to use binary format, the provided message is written as a
BinaryCDR record. If this CDR entity is configured to use text format, an exception is
thrown.cdr
- the CDR to write.WriteTimeoutException
- if the CDR cannot be written within the entity's configured
write timeout.StreamNotFoundException
- if the RA did not initialise properly, or the default
stream is missing.IOException
- if the CDR cannot be written due to a write error.IllegalArgumentException
- if the CDR RA is configured for text output.writeCDR(Message, String)
void writeCDR(ExtensionMessage cdr) throws WriteTimeoutException, StreamNotFoundException, IOException
writeCDR(ExtensionMessage
extensionCdr, String streamName)
but is targeted towards the default stream. cdr
- the CDR with extension definitions to write.WriteTimeoutException
- if the CDR cannot be written within the entity's configured
write timeout.StreamNotFoundException
- if the RA did not initialise properly, or the default stream
is missing.IOException
- if the CDR cannot be written due to a write error.IllegalArgumentException
- if the CDR RA is configured for text output.writeCDR(ExtensionMessage, String)
void writeCDR(com.google.protobuf.Message cdr, String streamName) throws WriteTimeoutException, StreamNotFoundException, IOException
cdr
- the CDR to write.streamName
- the name of the stream to write to.WriteTimeoutException
- if the CDR cannot be written within the entity's configured
write timeoutStreamNotFoundException
- if the RA did not initialise properly, or the stream is
missing.IOException
- if the CDR cannot be written due to a write errorIllegalArgumentException
- if the CDR RA is configured for text outputvoid writeCDR(ExtensionMessage cdr, String streamName) throws WriteTimeoutException, StreamNotFoundException, IOException
cdr
- the CDR with extension definitions to write.streamName
- the name of the stream to write to.WriteTimeoutException
- if the CDR cannot be written within the entity's configured
write timeout.StreamNotFoundException
- if the RA did not initialise properly, or the stream is
missing.IOException
- if the CDR cannot be written due to a write error.IllegalArgumentException
- if the CDR RA is configured for text output.@Deprecated void writeCDR(CallDetailRecord cdr) throws WriteTimeoutException, IOException
The provided instance may be a SBB-specific subclass of CallDetailRecord; it should override toString() to provide an appropriately-formatted single CDR output line (without newline) for the CDR.
cdr
- the CDR to write.WriteTimeoutException
- if the CDR cannot be written within the entity's configured
write timeoutIOException
- if the RA did not initialise properly, or the CDR cannot be written due
to a write error.boolean isOperational() throws StreamNotFoundException
isOperational(String streamName)
but
is targeted towards the default stream.StreamNotFoundException
- if the RA did not initialise properly, or the default stream
is missing.isOperational(String)
boolean isOperational(String streamName) throws StreamNotFoundException
streamName
- the name of the stream to write to.StreamNotFoundException
- if the RA did not initialise properly, or the stream is missing.CdrFileType getFileFormat() throws StreamNotFoundException
getFileFormat(String streamName)
but
is targeted towards the default stream.StreamNotFoundException
- if the RA did not initialise properly, or the default stream is
missing.getFileFormat(String)
CdrFileType getFileFormat(String streamName) throws StreamNotFoundException
streamName
- the name of the stream to write to.StreamNotFoundException
- if the RA did not initialise properly, or the stream is missing.