|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.blojsom.blog.Blog
Blog
Field Summary |
Constructor Summary | |
Blog(java.util.Properties blogConfiguration)
Create a blog with the supplied configuration properties |
Method Summary | |
boolean |
checkAuthorization(java.lang.String username,
java.lang.String password)
Deprecated. |
java.util.Map |
getAuthorization()
Returns the authorization map for this blog |
java.lang.String |
getAuthorizedUserEmail(java.lang.String username)
Return the e-mail address of an authorized user from this blog. |
java.util.Locale |
getBlogAdministrationLocale()
Retrieve the blog administration locale as a Locale object |
java.lang.String |
getBlogAdministrationLocaleAsString()
Retrieve the blog administration locale as a String |
java.lang.String |
getBlogAdminURL()
Admin URL for the blog |
java.lang.String |
getBlogBaseURL()
Base URL for the blog |
java.lang.String |
getBlogCommentsDirectory()
Get the directory where blog comments will be written to under the individual blog category directories |
java.lang.Boolean |
getBlogCommentsEnabled()
Return whether or not comments are enabled |
java.lang.String |
getBlogCountry()
Country of the blog |
java.lang.String[] |
getBlogDefaultCategoryExclusionMappings()
Return the list of categories that should be excluded from the default category '/' |
java.lang.String |
getBlogDefaultCategoryExclusionMappingsAsString()
Return the list of categories that should be excluded from the default category '/' as a String |
java.lang.String[] |
getBlogDefaultCategoryMappings()
Return the list of categories that should be mapped to the default category '/' |
java.lang.String |
getBlogDefaultCategoryMappingsAsString()
Return the list of categories that should be mapped to the default category '/' as a String |
java.lang.String |
getBlogDefaultFlavor()
Get the default flavor for this blog |
int |
getBlogDepth()
Return the depth to which blog entries will be searched |
java.lang.String |
getBlogDescription()
Description of the blog |
java.lang.String[] |
getBlogDirectoryFilter()
Get the list of directories that should be filtered when looking for categories |
int |
getBlogDisplayEntries()
Return the number of blog entries to retrieve from the individual categories |
java.lang.Boolean |
getBlogEmailEnabled()
Get whether or not email is enabled |
java.lang.String |
getBlogEntryMetaDataExtension()
Get the file extension for blog entry meta-data |
java.lang.String |
getBlogFileEncoding()
Get the file encoding for blog entries |
java.lang.String[] |
getBlogFileExtensions()
Return the list of blog file extensions |
java.lang.String |
getBlogHome()
Return the directory where blog entries are stored |
java.lang.String |
getBlogLanguage()
Language of the blog |
java.util.Locale |
getBlogLocale()
Retrive a Locale object from the blog's language and country settings |
java.lang.String |
getBlogName()
Name of the blog |
java.lang.String |
getBlogOwner()
Return the blog owner's name |
java.lang.String |
getBlogOwnerEmail()
Return the blog owner's e-mail address |
java.lang.String |
getBlogPingbacksDirectory()
Get the directory where blog pingbacks will be written to under the individual blog category directories |
java.lang.Boolean |
getBlogPingbacksEnabled()
Return whether or not pingbacks are enabled |
java.util.Map |
getBlogProperties()
Returns a read-only view of the properties for this blog |
java.lang.String[] |
getBlogPropertiesExtensions()
Return the list of blog properties file extensions |
java.lang.String |
getBlogProperty(java.lang.String propertyName)
Return a named property from the blog properties |
java.lang.String |
getBlogTrackbackDirectory()
Get the directory where blog trackbacks will be written to under the individual blog category directories |
java.lang.Boolean |
getBlogTrackbacksEnabled()
Return whether or not trackbacks are enabled |
java.lang.String |
getBlogURL()
URL for the blog |
java.lang.String |
getDigestAlgorithm()
Retrieve the in-use password digest algorithm |
java.lang.String |
getEscapedBlogDescription()
Returns the HTML escaped description of the blog |
java.lang.String |
getEscapedBlogName()
Returns the HTML escaped name of the blog |
java.lang.Boolean |
getLinearNavigationEnabled()
Is linear navigation enabled? |
java.lang.Boolean |
getUseEncryptedPasswords()
Retrieve whether or not MD5 encrypted passwords are used |
java.lang.Boolean |
getXmlrpcEnabled()
Is XML-RPC enabled for this blog? |
void |
setAdminBlogURL(java.lang.String blogAdminURL)
Set the new admin URL for the blog |
boolean |
setAuthorization(java.util.Map authorization)
Set the Username/Password table used for blog authorization. |
void |
setAuthorizedUserEmail(java.lang.String username,
java.lang.String email)
Set a new e-mail address for an authorized user for this blog. |
void |
setAuthorizedUserPassword(java.lang.String username,
java.lang.String password)
Set a new password for an authorized user for this blog. |
void |
setBlogAdministrationLocale(java.lang.String blogAdministrationLocale)
Set the locale used in the administration console |
void |
setBlogAdminURL(java.lang.String blogAdminURL)
Set the new admin URL for the blog |
void |
setBlogBaseURL(java.lang.String blogBaseURL)
Set the new base URL for the blog |
void |
setBlogCommentsEnabled(java.lang.Boolean blogCommentsEnabled)
Set whether blog comments are enabled |
void |
setBlogCountry(java.lang.String blogCountry)
Set the new 2 letter country code for the blog |
void |
setBlogDefaultCategoryExclusiondMappings(java.lang.String[] blogDefaultCategoryExclusionMappings)
Set the new default blog category exclusion mappings |
void |
setBlogDefaultCategoryMappingForFlavor(java.lang.String flavorKey,
java.lang.String blogDefaultCategoryMapping)
Set the new blog default category mapping for a particular flavor |
void |
setBlogDefaultCategoryMappings(java.lang.String[] blogDefaultCategoryMappings)
Set the new default blog category mappings |
void |
setBlogDefaultFlavor(java.lang.String blogDefaultFlavor)
Set the new default flavor for this blog |
void |
setBlogDepth(int blogDepth)
Set the depth to which blojsom should look for directories, where -1 indicates infinite depth search |
void |
setBlogDescription(java.lang.String blogDescription)
Set the new description for the blog |
void |
setBlogDisplayEntries(int blogDisplayEntries)
Set the number of entries to display at one time, where -1 indicates to display all entries |
void |
setBlogEmailEnabled(java.lang.Boolean blogEmailEnabled)
Set whether emails are sent on blog comments and trackbacks |
void |
setBlogFileEncoding(java.lang.String blogFileEncoding)
Set the new blog file encoding |
void |
setBlogFileExtensions(java.lang.String blogFileExtensions)
Set the new set of blog file extensions |
void |
setBlogLanguage(java.lang.String blogLanguage)
Set the new 2 letter language code for the blog |
void |
setBlogName(java.lang.String blogName)
Set the new name for the blog |
void |
setBlogOwner(java.lang.String blogOwner)
Set the new blog owner name |
void |
setBlogOwnerEmail(java.lang.String blogOwnerEmail)
Set the new blog owner e-mail address |
void |
setBlogPingbacksEnabled(java.lang.Boolean blogPingbacksEnabled)
Set whether blog pingbacks are enabled |
void |
setBlogProperty(java.lang.String key,
java.lang.String value)
Set a blog property. |
void |
setBlogTrackbacksEnabled(java.lang.Boolean blogTrackbacksEnabled)
Set whether blog trackbacks are enabled |
void |
setBlogURL(java.lang.String blogURL)
Set the new URL for the blog |
void |
setDigestAlgorithm(java.lang.String digestAlgorithm)
Set the in-use password digest algorithm |
void |
setLinearNavigationEnabled(java.lang.Boolean linearNavigationEnabled)
Set whether or not linear navigation should be enabled |
void |
setUseEncryptedPasswords(java.lang.Boolean useEncryptedPasswords)
Set whether or not MD5 encrypted passwords are used |
void |
setXmlrpcEnabled(java.lang.Boolean xmlrpcEnabled)
Set whether or not XML-RPC is enabled |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public Blog(java.util.Properties blogConfiguration) throws BlojsomConfigurationException
blogConfiguration
- Blog configuration properties
BlojsomConfigurationException
- If there is an error configuring the blogMethod Detail |
public boolean checkAuthorization(java.lang.String username, java.lang.String password)
username
- Username of the userpassword
- Password for the Username
AuthorizationProvider.authorize(org.blojsom.blog.BlogUser, java.util.Map, java.lang.String, java.lang.String)
public java.lang.String getAuthorizedUserEmail(java.lang.String username)
null
is returned.
username
- Authorized username
null
is username is not availablepublic void setAuthorizedUserEmail(java.lang.String username, java.lang.String email)
username
- Usernameemail
- E-mail addresspublic void setAuthorizedUserPassword(java.lang.String username, java.lang.String password)
username
- Usernamepassword
- Passwordpublic java.lang.String getBlogHome()
public java.lang.String[] getBlogFileExtensions()
public java.lang.String[] getBlogPropertiesExtensions()
public int getBlogDepth()
public java.lang.String getBlogName()
public java.lang.String getEscapedBlogName()
public java.lang.String getBlogDescription()
public java.lang.String getEscapedBlogDescription()
public java.lang.String getBlogURL()
public java.lang.String getBlogAdminURL()
public java.lang.String getBlogBaseURL()
public java.lang.String getBlogLanguage()
public java.lang.String getBlogCountry()
public int getBlogDisplayEntries()
public java.lang.String[] getBlogDefaultCategoryMappings()
public java.lang.String[] getBlogDefaultCategoryExclusionMappings()
public java.lang.String getBlogDefaultCategoryMappingsAsString()
public java.lang.String getBlogDefaultCategoryExclusionMappingsAsString()
public boolean setAuthorization(java.util.Map authorization)
authorization
- HashMap of Usernames and Passwords
public java.util.Map getAuthorization()
public java.lang.String getBlogOwnerEmail()
public java.lang.String getBlogOwner()
public java.util.Map getBlogProperties()
public java.lang.String getBlogCommentsDirectory()
public java.lang.String[] getBlogDirectoryFilter()
public java.lang.String getBlogTrackbackDirectory()
public java.lang.String getBlogPingbacksDirectory()
public java.lang.Boolean getBlogCommentsEnabled()
public java.lang.Boolean getBlogTrackbacksEnabled()
true
if trackbacks are enabled, false
otherwisepublic java.lang.Boolean getBlogPingbacksEnabled()
true
if pingbacks are enabled, false
otherwisepublic java.lang.Boolean getBlogEmailEnabled()
public java.lang.String getBlogEntryMetaDataExtension()
public java.lang.String getBlogFileEncoding()
public java.lang.String getBlogProperty(java.lang.String propertyName)
propertyName
- Name of the property to retrieve
null
if the property is not foundpublic java.lang.String getBlogDefaultFlavor()
public void setBlogName(java.lang.String blogName)
blogName
- Blog namepublic void setBlogDescription(java.lang.String blogDescription)
blogDescription
- Blog descriptionpublic void setBlogURL(java.lang.String blogURL)
blogURL
- Blog URLpublic void setAdminBlogURL(java.lang.String blogAdminURL)
blogAdminURL
- Blog admin URLpublic void setBlogBaseURL(java.lang.String blogBaseURL)
blogBaseURL
- Blog base URLpublic void setBlogCountry(java.lang.String blogCountry)
blogCountry
- Blog country codepublic void setBlogLanguage(java.lang.String blogLanguage)
blogLanguage
- Blog language codepublic void setBlogDepth(int blogDepth)
blogDepth
- Blog directory depthpublic void setBlogDisplayEntries(int blogDisplayEntries)
blogDisplayEntries
- Blog display entriespublic void setBlogDefaultCategoryMappings(java.lang.String[] blogDefaultCategoryMappings)
blogDefaultCategoryMappings
- Blog default category mappingspublic void setBlogDefaultCategoryExclusiondMappings(java.lang.String[] blogDefaultCategoryExclusionMappings)
blogDefaultCategoryExclusionMappings
- Blog default category exclusion mappingspublic void setBlogOwner(java.lang.String blogOwner)
blogOwner
- Blog ownerpublic void setBlogOwnerEmail(java.lang.String blogOwnerEmail)
blogOwnerEmail
- Blog owner e-mailpublic void setBlogCommentsEnabled(java.lang.Boolean blogCommentsEnabled)
blogCommentsEnabled
- true
if comments are enabled, false
otherwisepublic void setBlogEmailEnabled(java.lang.Boolean blogEmailEnabled)
blogEmailEnabled
- true
if email of comments and trackbacks is enabled, false
otherwisepublic void setBlogTrackbacksEnabled(java.lang.Boolean blogTrackbacksEnabled)
blogTrackbacksEnabled
- true
if trackbacks are enabled, false
otherwisepublic void setBlogPingbacksEnabled(java.lang.Boolean blogPingbacksEnabled)
blogPingbacksEnabled
- true
if pingbacks are enabled, false
otherwisepublic void setBlogFileEncoding(java.lang.String blogFileEncoding)
blogFileEncoding
- Blog file encodingpublic void setBlogDefaultCategoryMappingForFlavor(java.lang.String flavorKey, java.lang.String blogDefaultCategoryMapping)
flavorKey
- Flavor key (must end in blog-default-category-mapping)blogDefaultCategoryMapping
- New blog category mappingpublic void setBlogFileExtensions(java.lang.String blogFileExtensions)
blogFileExtensions
- Comma-separated list of blog file extensionspublic void setBlogDefaultFlavor(java.lang.String blogDefaultFlavor)
blogDefaultFlavor
- New default blog flavorpublic void setBlogProperty(java.lang.String key, java.lang.String value)
blog-home
, blog-comments-directory
,
and blog-trackbacks-directory
.
key
- Blog property keyvalue
- Blog property valuepublic java.lang.Boolean getLinearNavigationEnabled()
true
if linear navigation is enabled, false
otherwisepublic void setLinearNavigationEnabled(java.lang.Boolean linearNavigationEnabled)
linearNavigationEnabled
- true
if linear navigation is enabled, false
otherwisepublic java.lang.Boolean getXmlrpcEnabled()
true
if XML-RPC is enabled, false
otherwisepublic void setXmlrpcEnabled(java.lang.Boolean xmlrpcEnabled)
xmlrpcEnabled
- true
if XML-RPC is enabled, false
otherwisepublic java.lang.String getBlogAdministrationLocaleAsString()
public java.util.Locale getBlogAdministrationLocale()
Locale
object
Locale
object for blog administration localepublic void setBlogAdministrationLocale(java.lang.String blogAdministrationLocale)
blogAdministrationLocale
- Locale string of form language_country_variant
public java.util.Locale getBlogLocale()
Locale
object from the blog's language and country settings
Locale
object from the blog's language and country settingspublic java.lang.Boolean getUseEncryptedPasswords()
true
if encrypted passwords are used, false
otherwisepublic void setUseEncryptedPasswords(java.lang.Boolean useEncryptedPasswords)
useEncryptedPasswords
- true
if MD5 passwords are used, false
otherwisepublic void setBlogAdminURL(java.lang.String blogAdminURL)
blogAdminURL
- Blog admin URLpublic java.lang.String getDigestAlgorithm()
public void setDigestAlgorithm(java.lang.String digestAlgorithm)
digestAlgorithm
- Digest algorithm
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |