I understand why you didn't get any replies, because you didn't mention the requirement in detail.
The filesystem hook can be developed in a variety of ways to customize different aspects of the Document & Media portlet.
But since you requirement is:
we would focus on achieving this.
Here is what I think you should do:
1) For user-defined table I suppose you must have already built code to add,update or delete from the table through service-builder (this is the best way to work with database entities in liferay) or someother way.
2) So now every time a document is deleted you need to update the custom table. So you need to have a method which would be executed when a document is deleted and in that method you can call the code to update your custom table (this code you might have already built).
3) So now there are two ways to hook your functionality when the document is deleted either use ServiceWrappers or you can use ModelListeners.
4) So if you go with the ServiceWrapper way (nice guide for implementing this) then you can either override the DLFileEntryService or DLFileEntryLocalService using the wrapper like DLFileEntryServiceWrapper. Then you can just include the delete() (there might be more than one of them) method and put your custom code in that delete method but don't forget to include the call to super.delete() so that the actual method runs and your custom method also runs.
5) Now if you go the ModelListeners which is better since you won't have to worry about how many method you need to override in a wrapper or which class you need to override etc etc. So here is how to do it with ModelListener.
A short tutorial (assuming you are using Liferay 6+) you can also go through this short guide:
1) Edit your liferay-hook.xml as follows:
2) Add portal.properties file in src folder of WEB-INF.
3) Edit the portal.properties as follows:
This property is of the type value.object.listener.[the full path to the Model being added]
4) Now create a class com.my.custom.hook.CustomFileSystemListener and then create a method in this class which implements ModelListener<DLFileEntry>.
5) Override any of the two methods based on your requirement: onAfterRemove(DLFileEntry fileEntry) or onBeforeRemove(DLFileEntry fileEntry).
6) Write your custom code in any of the two methods using the full object of the file entry you are removing.
7) Ok it is done, now please deploy and have fun.
Hope this helps. Let me know if you face any issues.
Note: I could have developed a full-fledged example as you wanted but you know this way it is so much more fun isn't it! (building your own stuff) ... what! No! please don't curse me for this
The filesystem hook can be developed in a variety of ways to customize different aspects of the Document & Media portlet.
But since you requirement is:
santhosh kumar:
Actually my requirement is to update a user defined table on every document delete
we would focus on achieving this.
Here is what I think you should do:
1) For user-defined table I suppose you must have already built code to add,update or delete from the table through service-builder (this is the best way to work with database entities in liferay) or someother way.
2) So now every time a document is deleted you need to update the custom table. So you need to have a method which would be executed when a document is deleted and in that method you can call the code to update your custom table (this code you might have already built).
3) So now there are two ways to hook your functionality when the document is deleted either use ServiceWrappers or you can use ModelListeners.
4) So if you go with the ServiceWrapper way (nice guide for implementing this) then you can either override the DLFileEntryService or DLFileEntryLocalService using the wrapper like DLFileEntryServiceWrapper. Then you can just include the delete() (there might be more than one of them) method and put your custom code in that delete method but don't forget to include the call to super.delete() so that the actual method runs and your custom method also runs.
5) Now if you go the ModelListeners which is better since you won't have to worry about how many method you need to override in a wrapper or which class you need to override etc etc. So here is how to do it with ModelListener.
A short tutorial (assuming you are using Liferay 6+) you can also go through this short guide:
1) Edit your liferay-hook.xml as follows:
<hook>
<portal-properties>portal.properties</portal-properties>
</hook>2) Add portal.properties file in src folder of WEB-INF.
3) Edit the portal.properties as follows:
value.object.listener.com.liferay.portlet.documentlibrary.model.DLFileEntry=com.my.custom.hook.CustomFileSystemListenerThis property is of the type value.object.listener.[the full path to the Model being added]
4) Now create a class com.my.custom.hook.CustomFileSystemListener and then create a method in this class which implements ModelListener<DLFileEntry>.
5) Override any of the two methods based on your requirement: onAfterRemove(DLFileEntry fileEntry) or onBeforeRemove(DLFileEntry fileEntry).
6) Write your custom code in any of the two methods using the full object of the file entry you are removing.
7) Ok it is done, now please deploy and have fun.
Hope this helps. Let me know if you face any issues.
Note: I could have developed a full-fledged example as you wanted but you know this way it is so much more fun isn't it! (building your own stuff) ... what! No! please don't curse me for this
Hi Prakash,
Thank you for providing me a solution.
I tired as per your suggesion but after deleting a document the code which i have written is not working .
package com.my.custom.hook;
import com.liferay.portal.ModelListenerException;
import com.liferay.portal.model.ModelListener;
import com.liferay.portlet.documentlibrary.model.DLFileEntry;
public class CustomFileSystemListener implements ModelListener<DLFileEntry> {
@Override
public void onAfterAddAssociation(Object arg0, String arg1, Object arg2) throws ModelListenerException {
// TODO Auto-generated method stub
}
@Override
public void onAfterCreate(DLFileEntry arg0) throws ModelListenerException {
// TODO Auto-generated method stub
}
@Override
public void onAfterRemove(DLFileEntry arg0) throws ModelListenerException {
System.out.println("File deletion *****onAfterRemove");
}
@Override
public void onAfterRemoveAssociation(Object arg0, String arg1, Object arg2) throws ModelListenerException {
// TODO Auto-generated method stub
}
@Override
public void onAfterUpdate(DLFileEntry arg0) throws ModelListenerException {
// TODO Auto-generated method stub
}
@Override
public void onBeforeAddAssociation(Object arg0, String arg1, Object arg2) throws ModelListenerException {
// TODO Auto-generated method stub
}
@Override
public void onBeforeCreate(DLFileEntry arg0) throws ModelListenerException {
// TODO Auto-generated method stub
}
@Override
public void onBeforeRemove(DLFileEntry arg0) throws ModelListenerException {
System.out.println("File deletion *****onBeforeRemove");
}
@Override
public void onBeforeRemoveAssociation(Object arg0, String arg1, Object arg2) throws ModelListenerException {
// TODO Auto-generated method stub
}
@Override
public void onBeforeUpdate(DLFileEntry arg0) throws ModelListenerException {
// TODO Auto-generated method stub
}
}
Thank you for providing me a solution.
I tired as per your suggesion but after deleting a document the code which i have written is not working .
package com.my.custom.hook;
import com.liferay.portal.ModelListenerException;
import com.liferay.portal.model.ModelListener;
import com.liferay.portlet.documentlibrary.model.DLFileEntry;
public class CustomFileSystemListener implements ModelListener<DLFileEntry> {
@Override
public void onAfterAddAssociation(Object arg0, String arg1, Object arg2) throws ModelListenerException {
// TODO Auto-generated method stub
}
@Override
public void onAfterCreate(DLFileEntry arg0) throws ModelListenerException {
// TODO Auto-generated method stub
}
@Override
public void onAfterRemove(DLFileEntry arg0) throws ModelListenerException {
System.out.println("File deletion *****onAfterRemove");
}
@Override
public void onAfterRemoveAssociation(Object arg0, String arg1, Object arg2) throws ModelListenerException {
// TODO Auto-generated method stub
}
@Override
public void onAfterUpdate(DLFileEntry arg0) throws ModelListenerException {
// TODO Auto-generated method stub
}
@Override
public void onBeforeAddAssociation(Object arg0, String arg1, Object arg2) throws ModelListenerException {
// TODO Auto-generated method stub
}
@Override
public void onBeforeCreate(DLFileEntry arg0) throws ModelListenerException {
// TODO Auto-generated method stub
}
@Override
public void onBeforeRemove(DLFileEntry arg0) throws ModelListenerException {
System.out.println("File deletion *****onBeforeRemove");
}
@Override
public void onBeforeRemoveAssociation(Object arg0, String arg1, Object arg2) throws ModelListenerException {
// TODO Auto-generated method stub
}
@Override
public void onBeforeUpdate(DLFileEntry arg0) throws ModelListenerException {
// TODO Auto-generated method stub
}
}
